Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Improve version handling and build process #482

Merged
merged 1 commit into from
Feb 21, 2025
Merged

Conversation

tphakala
Copy link
Owner

  • Update Dockerfile to use BUILD_VERSION instead of VERSION
  • Modify main.go to display version without 'v' prefix
  • Update Taskfile.yml to support custom version via BUILD_VERSION
  • Enhance GitHub workflows for nightly and release builds to use consistent version detection
  • Improve version tagging and manifest creation in CI/CD pipelines

- Update Dockerfile to use BUILD_VERSION instead of VERSION
- Modify main.go to display version without 'v' prefix
- Update Taskfile.yml to support custom version via BUILD_VERSION
- Enhance GitHub workflows for nightly and release builds to use consistent version detection
- Improve version tagging and manifest creation in CI/CD pipelines
@tphakala tphakala merged commit 2bff84b into main Feb 21, 2025
6 checks passed
Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update the CI/CD workflows, Dockerfile, Taskfile, and main.go to use dynamic versioning based on Git tags. New steps in the workflows retrieve the version via a Git command and propagate this value as an environment variable, replacing hardcoded strings in Docker build arguments and manifest creation. The Dockerfile and Taskfile now use a BUILD_VERSION variable, and the version output in main.go is simplified. This overall modification enhances traceability and consistency in build and release processes.

Changes

File(s) Change Summary
.github/workflows/nightly-build.yml and
.github/workflows/release-build.yml
Added a "Get version" step that runs git describe --tags --always to capture the current version, updated build step arguments and manifest creation commands to use the dynamic version instead of hardcoded values.
Dockerfile and Taskfile.yml Replaced the VERSION variable with BUILD_VERSION; modified Dockerfile to set a default value and include a log statement; updated Taskfile to conditionally prioritize BUILD_VERSION over the git query output.
main.go Modified the version output format by removing the prefixed "v", resulting in a simpler display of the version information.

Sequence Diagram(s)

sequenceDiagram
    participant W as Workflow Engine
    participant G as GetVersion Step
    participant D as Docker Build
    participant M as Manifest Creation

    W->>G: Run "Get version" (git describe)
    G-->>W: Return version value
    W->>D: Trigger Docker Build using BUILD_VERSION
    W->>M: Execute manifest creation with BUILD_VERSION
Loading

Possibly related PRs

Suggested reviewers

  • isZumpo

Poem

I'm a rabbit hopping through the code,
Skipping along with a dynamic mode.
Git tags now lead the version dance,
Docker and manifests join in the prance.
In build and release, we now shine bright –
A bundle of change in every byte!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c46b148 and 19d474e.

📒 Files selected for processing (5)
  • .github/workflows/nightly-build.yml (4 hunks)
  • .github/workflows/release-build.yml (5 hunks)
  • Dockerfile (3 hunks)
  • Taskfile.yml (1 hunks)
  • main.go (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@tphakala tphakala deleted the version-tag-fixes branch February 22, 2025 08:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant