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: Update makeLatest condition to exclude alpha and beta branches #209

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

Ovler-Young
Copy link
Contributor

@Ovler-Young Ovler-Young commented Dec 23, 2024

Summary by Sourcery

CI:

  • Update the build workflow to prevent marking builds from the "alpha" and "beta" branches as the "latest" build.

Copy link

sourcery-ai bot commented Dec 23, 2024

Reviewer's Guide by Sourcery

This pull request updates the makeLatest condition in the build workflow to exclude alpha and beta branches. This ensures that artifacts from these branches are not marked as the latest release.

State diagram for release artifact tagging logic

stateDiagram-v2
    [*] --> CheckBranchName
    CheckBranchName --> ContainsAlphaOrBeta: Check ref_name
    ContainsAlphaOrBeta --> NotLatest: Yes
    ContainsAlphaOrBeta --> MarkAsLatest: No
    NotLatest --> [*]: makeLatest=false
    MarkAsLatest --> [*]: makeLatest=true
Loading

File-Level Changes

Change Details Files
Updated the makeLatest condition
  • The makeLatest condition was changed from true to `${{ !(contains(github.ref_name, 'alpha')

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Ovler-Young - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@@ -75,7 +75,7 @@ jobs:
allowUpdates: true
replacesArtifacts: false
omitBodyDuringUpdate: true
makeLatest: true
makeLatest: ${{ !(contains(github.ref_name, 'alpha') || contains(github.ref_name, 'beta')) }}
Copy link

Choose a reason for hiding this comment

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

suggestion: Consider extracting the repeated release type check into a reusable expression

This expression is repeated 7 times in the workflow. Consider defining it as a workflow-level environment variable or composite action to improve maintainability. For example: env: { IS_STABLE_RELEASE: ${{ !(contains(github.ref_name, 'alpha') || contains(github.ref_name, 'beta')) }} }

Suggested implementation:

          allowUpdates: true
          replacesArtifacts: false
          omitBodyDuringUpdate: true
          makeLatest: ${{ env.IS_STABLE_RELEASE }}

          allowUpdates: true
          replacesArtifacts: false
          omitBodyDuringUpdate: true
          makeLatest: ${{ env.IS_STABLE_RELEASE }}

You'll need to add this environment variable definition at the workflow level (near the top of the file, likely just after the name: field):

env:
  IS_STABLE_RELEASE: ${{ !(contains(github.ref_name, 'alpha') || contains(github.ref_name, 'beta')) }}

Also, you'll need to replace all other occurrences of this same expression throughout the workflow file with ${{ env.IS_STABLE_RELEASE }}. Based on your comment, there are 7 total occurrences that need to be replaced.

@Losses Losses merged commit 2dad3bc into Losses:master Dec 23, 2024
1 of 2 checks passed
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.

2 participants