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(ci): move skip_checks to step #3163

Merged
merged 1 commit into from
Nov 18, 2024
Merged

Conversation

gartnera
Copy link
Member

@gartnera gartnera commented Nov 14, 2024

check-goreleaser is a required step for doing the release. So we need to move the conditional to the step rather than the job.

Summary by CodeRabbit

  • New Features

    • Enhanced control over the release process with options to skip checks and releases based on user inputs.
  • Bug Fixes

    • Improved execution flow for jobs related to release verification and changelog checks.

@gartnera gartnera added the no-changelog Skip changelog CI check label Nov 14, 2024
Copy link
Contributor

coderabbitai bot commented Nov 14, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the .github/workflows/publish-release.yml file, enhancing the conditional execution of workflow steps based on the parameters inputs.skip_checks and inputs.skip_release. The check-goreleaser and check-changelog jobs now include conditions to determine whether to execute certain commands and steps, ensuring that operations are only performed when checks are not skipped. Additionally, the publish-release job is conditioned to prevent execution if inputs.skip_release is true, maintaining dependencies on prior jobs.

Changes

File Change Summary
.github/workflows/publish-release.yml Modified conditional execution for check-goreleaser and check-changelog jobs based on inputs.skip_checks. Updated publish-release job to skip execution if inputs.skip_release is true.

Possibly related PRs

  • ci: cleanup release workflow #2845: This PR modifies the same workflow file .github/workflows/publish-release.yml, focusing on input parameters and conditional logic, which is directly related to the changes made in the main PR.
  • feat: improve build reproducability #3091: This PR also updates the .github/workflows/publish-release.yml file, enhancing its functionality with new input parameters and modifications to job steps, aligning closely with the changes in the main PR.

Suggested reviewers

  • lumtis
  • skosito

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 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.

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.

@github-actions github-actions bot added the ci Changes to CI pipeline or github actions label Nov 14, 2024
@gartnera gartnera force-pushed the fix-publish-release-skip-checks branch from 31cc41f to c3a70e9 Compare November 14, 2024 22:43
@gartnera gartnera changed the title Fix publish release skip checks fix(ci): move skip_checks to step Nov 14, 2024
@gartnera gartnera marked this pull request as ready for review November 15, 2024 16:45
@gartnera gartnera requested a review from a team as a code owner November 15, 2024 16:45
@gartnera gartnera enabled auto-merge November 15, 2024 16:45
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: 0

🧹 Outside diff range and nitpick comments (2)
.github/workflows/publish-release.yml (2)

51-51: Consider using a more idiomatic condition syntax.

While the current condition works correctly, consider using if: ${{ !inputs.skip_checks }} for a more idiomatic GitHub Actions syntax. This maintains the same logic while being more explicit about boolean operations.


Line range hint 186-189: Improve cleanup step error handling.

The current cleanup fallback might mask real issues. Consider:

  1. Adding error logging
  2. Setting a non-zero exit code for failures
-        run: sudo rm -rf * || echo "failed to cleanup workspace please investigate"
+        run: |
+          if ! sudo rm -rf *; then
+            echo "ERROR: Failed to cleanup workspace" >&2
+            exit 1
+          fi
🧰 Tools
🪛 yamllint

[error] 54-54: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6fb64ca and c3a70e9.

📒 Files selected for processing (1)
  • .github/workflows/publish-release.yml (1 hunks)
🔇 Additional comments (3)
.github/workflows/publish-release.yml (3)

Line range hint 71-89: LGTM! Secure implementation of changelog verification.

The implementation:

  • Securely uses GITHUB_TOKEN for API authentication
  • Properly handles SHA comparison between develop and current branch
  • Includes clear error messaging for changelog updates
🧰 Tools
🪛 yamllint

[error] 54-54: trailing spaces

(trailing-spaces)


Line range hint 108-113: LGTM! Well-implemented security controls.

The job correctly implements:

  • Principle of least privilege with granular permissions
  • Environment protection for release process
  • Software supply chain security through build attestations
🧰 Tools
🪛 yamllint

[error] 54-54: trailing spaces

(trailing-spaces)


Line range hint 17-21: LGTM! Well-structured workflow configuration.

The workflow implements:

  • Proper concurrency control to prevent parallel releases
  • Clear job dependencies
  • Robust release process with appropriate checks
🧰 Tools
🪛 yamllint

[error] 54-54: trailing spaces

(trailing-spaces)

Copy link
Contributor

@morde08 morde08 left a comment

Choose a reason for hiding this comment

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

LGTM

@gartnera gartnera added this pull request to the merge queue Nov 18, 2024
Merged via the queue into develop with commit 9d299f0 Nov 18, 2024
44 of 45 checks passed
@gartnera gartnera deleted the fix-publish-release-skip-checks branch November 18, 2024 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Changes to CI pipeline or github actions no-changelog Skip changelog CI check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants