Skip to content

[ci] Use dots in release candidtate versions, as per SemVer - #890

Merged
Nick Volynkin (NickVolynkin) merged 1 commit into
mainfrom
use-dots-in-rc
Apr 25, 2025
Merged

[ci] Use dots in release candidtate versions, as per SemVer#890
Nick Volynkin (NickVolynkin) merged 1 commit into
mainfrom
use-dots-in-rc

Conversation

@NickVolynkin

@NickVolynkin Nick Volynkin (NickVolynkin) commented Apr 25, 2025 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Before: 0.31.0-rc1
After: 0.31.0-rc.1

Why this matters: we want to do things the right way from the start.
Version patten affects how versions are parsed and sorted.
For example, we have release candidates number 9 and 10:

  • In 'rc.9' and 'rc.10', the numeric parts are compared as numbers,
    so 9 comes before 10.
  • In 'rc9' and 'rc10', versions are compared lexicographically,
    so 10 comes before 9, which is wrong.

Reference: SemVer items 9–11. https://semver.org/#spec-item-9
Signed-off-by: Nick Volynkin nick.volynkin@gmail.com

Summary by CodeRabbit

  • Chores
    • Updated workflow to recognize and process release candidate tags with a dot separator (e.g., vX.Y.Z-rc.N).
    • Improved tag validation and error messaging to reflect the new tag format.

@coderabbitai

coderabbitai Bot commented Apr 25, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

"""

Walkthrough

The changes update the GitHub Actions workflow configuration for tag-based triggers. The workflow now separately matches stable version tags (vX.Y.Z) and release candidate tags (vX.Y.Z-rc.N). The tag parsing logic and regular expressions are revised to require a dot separator in release candidate tags (e.g., -rc.1 instead of -rc1). Associated comments, error messages, and output variable formats are updated to reflect this new convention. No modifications were made to the workflow’s overall logic or to any public or exported entities.

Changes

File(s) Change Summary
.github/workflows/tags.yaml Updated tag trigger patterns to split stable and RC tags; changed RC tag format to require dot; updated regex, comments, error messages, and outputs to match new -rc.N format.

Poem

A hop and a skip, the tags now align,
With dots for the RCs—oh, how they shine!
No more confusion, the pattern is clear,
Versioning magic, the carrots are near.
🥕✨

Hop on, dear workflow, your journey refined,
With every new tag, more carrots to find!
"""

📜 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 f537689 and 637551e.

📒 Files selected for processing (1)
  • .github/workflows/tags.yaml (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/tags.yaml
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build and Test

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

NickVolynkin
Nick Volynkin (NickVolynkin) commented Apr 25, 2025
View reviewed changes
Comment thread .github/workflows/tags.yaml
Comment on lines +6 to +7
- 'v*.*.*' # vX.Y.Z
- 'v*.*.*-rc.*' # vX.Y.Z-rc.N

@NickVolynkin Nick Volynkin (NickVolynkin) Apr 25, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I know that first pattern includes RC, but this way it's more explicit.

@NickVolynkin Nick Volynkin (NickVolynkin) mentioned this pull request Apr 25, 2025
Closed
@NickVolynkin
[ci] Use dots in release candidtate versions, as per SemVer
637551e 
Before: 0.31.0-rc1
After:  0.31.0-rc.1

Why this matters: we want to do things the right way from the start.
Version patten affects how versions are parsed and sorted.
For example, we have release candidates number 9 and 10:

* In 'rc.9' and 'rc.10', the numeric parts are compared as numbers,
  so 9 comes before 10.
* In 'rc9' and 'rc10', versions are compared lexicographically,
  so 10 comes before 9, which is wrong.

Reference: SemVer items 9–11. https://semver.org/#spec-item-9
Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin
Nick Volynkin (NickVolynkin) deleted the use-dots-in-rc branch April 25, 2025 11:13
@kvaps

Andrei Kvapil (kvaps) commented Apr 25, 2025

Copy link
Copy Markdown
Member

Nick Volynkin (@NickVolynkin) could you please also fix Finalize release pipeline?

https://github.com/cozystack/cozystack/actions/runs/14665130076/job/41158007078

@kvaps Andrei Kvapil (kvaps) mentioned this pull request Apr 25, 2025
Merged
Andrei Kvapil (kvaps) added a commit that referenced this pull request Apr 25, 2025
@kvaps
[ci] Use dots in release candidtate versions, as per SemVer (#901)
108fc64 
This change also fixes `finalizing release` workflow
#890 (comment)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Chores**
- Updated release tag validation to require a dot between "rc" and the
number (e.g., `v0.31.5-rc.1` instead of `v0.31.5-rc1`).
  - Adjusted error messages to reflect the new release tag format.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Timofei Larkin (lllamnyp) pushed a commit that referenced this pull request May 20, 2025
@kvaps @lllamnyp
[ci] Use dots in release candidtate versions, as per SemVer (#901)
b5f0dd8 
This change also fixes `finalizing release` workflow
#890 (comment)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Chores**
- Updated release tag validation to require a dot between "rc" and the
number (e.g., `v0.31.5-rc.1` instead of `v0.31.5-rc1`).
  - Adjusted error messages to reflect the new release tag format.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

(cherry picked from commit 108fc64)
Signed-off-by: Timofei Larkin <lllamnyp@gmail.com>
@coderabbitai coderabbitai Bot mentioned this pull request May 22, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lllamnyp Timofei Larkin (lllamnyp) lllamnyp approved these changes
@kvaps Andrei Kvapil (kvaps) Awaiting requested review from kvaps kvaps is a code owner
@klinch0 klinch0 Awaiting requested review from klinch0

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@NickVolynkin @kvaps @lllamnyp