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

fix(cicd): update tag extractor to support prereleases #1218

Merged
merged 3 commits into from
Jan 29, 2025
Merged

Conversation

sevenzing
Copy link
Contributor

@sevenzing sevenzing commented Jan 29, 2025

currently we only support tags like stats/v1.1.1. we also want to support tags likestats/v2.4.0-alpha.0 to produce prelease version v2.4.0-alpha.0

Summary by CodeRabbit

  • Chores
    • Updated Docker build workflow configuration to support more flexible version tag matching.
    • Expanded tag capture logic to allow broader version format parsing, accommodating pre-release identifiers and build metadata.

Copy link
Contributor

coderabbitai bot commented Jan 29, 2025

Warning

Rate limit exceeded

@sevenzing has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 21 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between fb22bf8 and 0182303.

📒 Files selected for processing (1)
  • .github/workflows/_push_swagger.yml (1 hunks)

Walkthrough

The pull request modifies the GitHub Actions workflow configuration for Docker build and push, specifically updating the regular expression pattern for tag matching. The new regex adheres to semantic versioning (semver) rules, allowing for optional pre-release and build metadata segments. This change enhances the flexibility of version matching by capturing a broader range of version formats. Additionally, the logic for extracting tag names has been refined to utilize new output groups from the regex step, defining variables for version, prerelease, and main. The conditional logic has been improved to determine the appropriate tags based on the matched versioning scheme. Overall, while the workflow's structure remains intact, significant enhancements have been made to the regex and tag extraction logic.

Possibly related PRs

Poem

🐰 Regex Rabbit's Versioning Dance
With whiskers twitching, tags now prance
Beyond the strict semver stance
A flexible pattern takes its chance
Capturing versions with playful glance
Docker builds hop with newfound grace! 🐾


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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 28cb9f0 and 5ff031e.

📒 Files selected for processing (1)
  • .github/workflows/_docker-build-push.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Docker build and docker push / build-and-push
  • GitHub Check: Docker build and docker push / build-and-push
  • GitHub Check: Unit, doc and integration tests
  • GitHub Check: Unit, doc and integration tests
  • GitHub Check: Linting / lint
  • GitHub Check: Unit, doc and integration tests
  • GitHub Check: Unit, doc and integration tests
  • GitHub Check: Unit, doc and integration tests
  • GitHub Check: Unit, doc and integration tests
  • GitHub Check: Unit, doc and integration tests

.github/workflows/_docker-build-push.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@bragov4ik bragov4ik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that it will still set latest tag for pre release version. I think it's not what we want though?

@bragov4ik
Copy link
Contributor

Do we also want to push swagger for pre releases?

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
.github/workflows/_docker-build-push.yml (1)

57-71: Consider enhancing the tagging strategy for better version management.

While the current implementation is functional, consider these improvements:

  1. Add major version tags (e.g., v2) for easier version pinning
  2. Add minor version tags (e.g., v2.4) for more granular control
  3. Consider adding a stable tag for the latest non-prerelease version

Here's how you could enhance the tag extraction:

 if [[ -n "$version" ]]; then
+  # Extract major and minor versions
+  major=$(echo "$version" | cut -d. -f1)
+  minor=$(echo "$version" | cut -d. -f1,2)
   if [[ -n "$prerelease" ]]; then
-    echo "tags=${{ env.IMAGE_NAME }}:$version" >> $GITHUB_OUTPUT
+    echo "tags=${{ env.IMAGE_NAME }}:$version,${{ env.IMAGE_NAME }}:$major-next,${{ env.IMAGE_NAME }}:$minor-next" >> $GITHUB_OUTPUT
   else
-    echo "tags=${{ env.IMAGE_NAME }}:$version, ${{ env.IMAGE_NAME }}:latest" >> $GITHUB_OUTPUT
+    echo "tags=${{ env.IMAGE_NAME }}:$version,${{ env.IMAGE_NAME }}:$major,${{ env.IMAGE_NAME }}:$minor,${{ env.IMAGE_NAME }}:latest,${{ env.IMAGE_NAME }}:stable" >> $GITHUB_OUTPUT
   fi
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5ff031e and fb22bf8.

📒 Files selected for processing (1)
  • .github/workflows/_docker-build-push.yml (1 hunks)

.github/workflows/_docker-build-push.yml Show resolved Hide resolved
@sevenzing
Copy link
Contributor Author

added semver regex to push-swagger job

Copy link
Contributor

@bragov4ik bragov4ik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!

@sevenzing sevenzing merged commit 2b3acf7 into main Jan 29, 2025
36 of 40 checks passed
@sevenzing sevenzing deleted the ll/fix-cicd branch January 29, 2025 10:35
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.

3 participants