Skip to content

Update release steps in CI workflow - #506

Merged
guibranco merged 2 commits into
mainfrom
guibranco-patch-1
Oct 17, 2025
Merged

Update release steps in CI workflow#506
guibranco merged 2 commits into
mainfrom
guibranco-patch-1

Conversation

@guibranco

@guibranco guibranco commented Oct 17, 2025

Copy link
Copy Markdown
Owner

📑 Description

Create latest release

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

☢️ Does this introduce a breaking change?

  • Yes
  • No

Summary by Sourcery

CI:

  • Rename existing release step to "Create Release (tag)" and add a new "Create Release (latest)" step that publishes or updates the 'latest' tag with generated release notes

Description by Korbit AI

What change is being made?

Update CI workflow to publish releases in two steps: rename the existing release step to "Create Release (tag)" and add a new "Create Release (latest)" step to publish a non-tagged, latest release with configurable options.

Why are these changes being made?

To publish both a tagged release and a separate latest release from CI, enabling latest releases while preserving tag-based releases. This provides users with stable tag-based releases and an additional latest release stream.

Is this description stale? Ask me to generate a new description by commenting /korbit-generate-pr-description

Summary by CodeRabbit

  • Chores
    • Updated release workflow to generate both version-specific and latest release tags, enabling easier access to the most recent version while preserving full version history.

@sourcery-ai

sourcery-ai Bot commented Oct 17, 2025

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR enhances the CI workflow by renaming the existing release step to focus on versioned tags and introducing a second step that creates or updates a ‘latest’ release with appropriate settings.

File-Level Changes

Change Details Files
Distinguish versioned release step from latest release
  • Renamed step to ‘Create Release (tag)’
  • Kept allowUpdates: false for the versioned release
.github/workflows/ci.yml
Add CI step to create/update ‘latest’ release
  • Added step named ‘Create Release (latest)’
  • Set tag to ‘latest’ with allowUpdates: true and skipIfReleaseExists: false
  • Enabled generateReleaseNotes and updated release body
.github/workflows/ci.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@guibranco
guibranco enabled auto-merge (squash) October 17, 2025 17:23
@gstraccini gstraccini Bot added the ☑️ auto-merge Automatic merging of pull requests (gstraccini-bot) label Oct 17, 2025

@korbit-ai korbit-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I've completed my review and didn't find any issues.

Check out our docs on how you can make Korbit work best for you and your team.

Loving Korbit!? Share us on LinkedIn Reddit and X

@coderabbitai

coderabbitai Bot commented Oct 17, 2025

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

The create-release workflow step is split into two separate steps: one for creating tagged releases and another for the latest release. The tag step formatting is consolidated to a single line, while a new latest step is added with additional configuration options.

Changes

Cohort / File(s) Change Summary
GitHub Actions Workflow Modification
.github/workflows/ci.yml
Refactored create-release step into two distinct steps: (1) "Create Release (tag)" with semver tagging and release notes generation, and (2) "Create Release (latest)" with makeLatest set to false and allowUpdates/skipIfReleaseExists enabled; consolidated body formatting to single-line expression.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A rabbit's release rhyme:
Two steps now dance where one stood tall,
Tagged and latest, answers to the call,
With gentle updates and notes so bright,
Our workflow flows with newfound might! 🚀

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch guibranco-patch-1

📜 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 4d62474 and 0f2e369.

📒 Files selected for processing (1)
  • .github/workflows/ci.yml (2 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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 17, 2025
@penify-dev penify-dev Bot added enhancement New feature or request Review effort [1-5]: 2 labels Oct 17, 2025
@penify-dev

penify-dev Bot commented Oct 17, 2025

Copy link
Copy Markdown

PR Review 🔍

⏱️ Estimated effort to review [1-5]

2, because the changes are straightforward and primarily involve updating the CI workflow with a new release step and renaming an existing step.

🧪 Relevant tests

No

⚡ Possible issues

No

🔒 Security concerns

No

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!

Blocking issues:

  • An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload. (link)
Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `.github/workflows/ci.yml:99` </location>
<code_context>
        uses: ncipollo/release-action@v1.20.0
</code_context>

<issue_to_address>
**security (yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha):** An action sourced from a third-party repository on GitHub is not pinned to a full length commit SHA. Pinning an action to a full length commit SHA is currently the only way to use an action as an immutable release. Pinning to a particular SHA helps mitigate the risk of a bad actor adding a backdoor to the action's repository, as they would need to generate a SHA-1 collision for a valid Git object payload.

*Source: opengrep*
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread .github/workflows/ci.yml
sourcery-ai[bot]
sourcery-ai Bot previously requested changes Oct 17, 2025

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

New security issues found

Comment thread .github/workflows/ci.yml
@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
1 Security Hotspot

See analysis details on SonarQube Cloud

@penify-dev

penify-dev Bot commented Oct 17, 2025

Copy link
Copy Markdown

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Best practice
Pin the action to a specific version to ensure stability

Consider using a specific version tag for the ncipollo/release-action to avoid potential
breaking changes in future updates.

.github/workflows/ci.yml [98-99]

 - name: Create Release (latest)
-  uses: ncipollo/release-action@v1.20.0
+  uses: ncipollo/release-action@v1.20.0  # Consider pinning to a specific version
 
Suggestion importance[1-10]: 8

Why: Pinning the action to a specific version can help ensure stability and prevent unexpected breaking changes in future updates.

8
Enhancement
Adjust the skipIfReleaseExists setting to prevent duplicate releases

Consider setting skipIfReleaseExists to true if you want to prevent duplicate releases.

.github/workflows/ci.yml [102]

-skipIfReleaseExists: false
+skipIfReleaseExists: true  # Prevent duplicate releases
 
Suggestion importance[1-10]: 7

Why: This suggestion addresses a potential issue with duplicate releases, which is important for maintaining a clean release history.

7
Possible issue
Ensure the allowUpdates setting aligns with your intended release strategy

Review the allowUpdates parameter in the Create Release (latest) step to ensure it aligns
with your release strategy.

.github/workflows/ci.yml [101]

-allowUpdates: true
+allowUpdates: false  # Review this setting based on your release strategy
 
Suggestion importance[1-10]: 6

Why: While this suggestion is relevant, the current setting of allowUpdates: true may be appropriate depending on the release strategy, making it a minor issue.

6
Ensure the makeLatest setting aligns with your tagging strategy

Review the makeLatest parameter to ensure it meets your requirements for tagging the
latest release.

.github/workflows/ci.yml [104]

-makeLatest: false
+makeLatest: true  # Adjust based on your tagging strategy
 
Suggestion importance[1-10]: 5

Why: This suggestion is valid but does not address a critical issue; it is more about ensuring alignment with tagging strategy, which may not be urgent.

5

@guibranco
guibranco disabled auto-merge October 17, 2025 17:28
@guibranco
guibranco merged commit 503e2a3 into main Oct 17, 2025
19 of 25 checks passed
@guibranco
guibranco deleted the guibranco-patch-1 branch October 17, 2025 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

☑️ auto-merge Automatic merging of pull requests (gstraccini-bot) enhancement New feature or request Review effort [1-5]: 2 size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant