Skip to content

v0.4.1: New versioning system with branch protection#13

Merged
finityfly merged 1 commit intomainfrom
feat-release
Jul 8, 2025
Merged

v0.4.1: New versioning system with branch protection#13
finityfly merged 1 commit intomainfrom
feat-release

Conversation

@finityfly
Copy link
Owner

@finityfly finityfly commented Jul 8, 2025

This pull request updates the GitHub Actions workflow for releases to improve its functionality and adapt it for use with pull requests. The key changes include switching the trigger from push to pull_request events, enhancing tag handling, and simplifying version bump logic.

Workflow Trigger Changes:

  • .github/workflows/release.yaml: Changed the workflow trigger to respond to pull_request events of type closed instead of push events. This ensures the workflow runs when a pull request is merged.

Tag and Version Handling Updates:

  • .github/workflows/release.yaml: Enhanced the logic to extract the version tag from the pull request title if available, falling back to the latest Git tag otherwise. This simplifies version management during releases.
  • .github/workflows/release.yaml: Updated all references to use steps.get_tag.outputs.new_tag instead of steps.bump.outputs.new_tag for consistency and clarity in tag handling.

Release Asset and Dispatch Adjustments:

  • .github/workflows/release.yaml: Modified the tarball creation and GitHub release steps to use the new tag output, ensuring accurate versioning in release assets.
  • .github/workflows/release.yaml: Adjusted the repository dispatch payload to reference the updated tag output for the tarball URL and version.

Summary by CodeRabbit

  • Chores
    • Updated the release workflow to trigger on closed pull requests to the main branch.
    • Improved version tagging by extracting the version from the pull request title or incrementing the latest tag automatically.
    • Streamlined workflow steps for tagging, release creation, and repository dispatch.

@coderabbitai
Copy link

coderabbitai bot commented Jul 8, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The release workflow was updated to trigger on closed pull requests targeting the main branch instead of push events. The version tag retrieval and bumping logic were consolidated into a single step, streamlining tag determination from the PR title or latest git tag. All subsequent steps now reference the unified tag output.

Changes

File(s) Change Summary
.github/workflows/release.yaml Changed workflow trigger to PR close on main; merged version bump/tag logic; updated tag references

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Git

    Developer ->> GitHub Actions: Close PR to main
    GitHub Actions ->> Git: Get PR title / latest tag
    Git-->>GitHub Actions: Return tag or incremented version
    GitHub Actions ->> Git: Tag, push, create tarball, release
Loading

Possibly related PRs

  • Release Type Support #2: Modifies version tagging and bumping logic in .github/workflows/release.yaml, introducing a release-type input for version increments.

Poem

A PR is closed, the workflow runs,
Tags and versions—merged as one!
No more bumps in separate steps,
The process now is smooth and deft.
With every release, the carrots cheer,
For tidy YAML brings good luck here! 🥕


📜 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 5468a5d and 3bd5045.

📒 Files selected for processing (1)
  • .github/workflows/release.yaml (3 hunks)

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

@finityfly finityfly merged commit cbac269 into main Jul 8, 2025
1 check was pending
@finityfly finityfly deleted the feat-release branch July 9, 2025 15:01
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