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

build: 📦 update release workflow with permissions and GoReleaser v6 #1

Merged
merged 1 commit into from
Oct 9, 2024

Conversation

blackfyre
Copy link
Owner

@blackfyre blackfyre commented Oct 9, 2024

This pull request includes updates to the GitHub Actions workflow for releases, specifically in the release.yml file. The main changes involve adding tag-based triggers, updating permissions, and modifying job steps to use more current versions and configurations.

Workflow updates:

Job configuration updates:

Summary by CodeRabbit

  • Chores
    • Updated release workflow to trigger on specific tag patterns.
    • Enhanced permissions for content access in the release process.
    • Specified stable Go version for setup.
    • Updated GoReleaser action to a more specific version.

Copy link

coderabbitai bot commented Oct 9, 2024

Walkthrough

The changes made in the pull request primarily affect the GitHub Actions workflow file located at .github/workflows/release.yml. Modifications include the addition of a push event trigger for tags matching the pattern "v*.." and a new permissions section granting write access to contents. Additionally, updates were made to the goreleaser job, including the use of a stable Go version and a specific version of the GoReleaser action.

Changes

File Change Summary
.github/workflows/release.yml - Added permissions: contents: write.
- Updated push: to include tags: - "v*.*.*".
- Changed uses: actions/setup-go@v5 with go-version: stable.
- Updated uses: goreleaser/goreleaser-action@v6 with version: "~> v2".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant GoReleaser

    User->>GitHub: Push tag "v1.0.0"
    GitHub->>GoReleaser: Trigger release workflow
    GoReleaser-->>GitHub: Perform release actions
    GitHub-->>User: Notify release completion
Loading

🐇 "In the land of code, where changes bloom,
A tag is pushed, dispelling gloom.
With permissions granted, the workflow sings,
GoReleaser dances, oh, the joy it brings!
Stable and ready, the code takes flight,
Hopping through versions, all feels just right!" 🐇


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.

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.

Copy link

@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: 1

🧹 Outside diff range and nitpick comments (1)
.github/workflows/release.yml (1)

9-10: LGTM: Explicit permissions set

Setting explicit permissions is a good security practice. The write access to contents is necessary for creating releases and uploading assets.

Consider being more specific with permissions if possible. If you only need to create releases and upload release assets, you could use:

permissions:
  contents: write
  packages: write

This would restrict the workflow to only the necessary permissions for releasing.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1f3265a and 7c28541.

📒 Files selected for processing (1)
  • .github/workflows/release.yml (2 hunks)
🧰 Additional context used
🔇 Additional comments (2)
.github/workflows/release.yml (2)

4-7: LGTM: Appropriate event triggers for releases

The addition of the push event trigger for tags matching "v*.." is a good practice for automating releases based on semantic versioning tags. Retaining the pull_request trigger allows for testing the release process on PRs, which is beneficial for catching issues before actual releases.


25-25: LGTM: GoReleaser action and version updates

The updates to the GoReleaser action and its version parameter are good improvements:

  1. Updating to goreleaser/goreleaser-action@v6 ensures you're using the latest major version of the action, which may include important features and bug fixes.
  2. Changing the version parameter to "~> v2" allows for compatible updates within v2. This is more stable than using "latest" while still allowing for minor version updates and patches.

These changes strike a good balance between staying up-to-date and maintaining stability.

Also applies to: 28-28

.github/workflows/release.yml Show resolved Hide resolved
@blackfyre blackfyre merged commit 4ba951b into main Oct 9, 2024
1 check failed
@blackfyre blackfyre deleted the chore-update-goreleaser branch October 9, 2024 12:38
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