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

ci: release automation with GoReleaser #22

Merged
merged 2 commits into from
May 6, 2024
Merged

ci: release automation with GoReleaser #22

merged 2 commits into from
May 6, 2024

Conversation

jamestelfer
Copy link
Owner

@jamestelfer jamestelfer commented May 6, 2024

Publishes to GitHub and DockerHub using GoReleaser.

The workflow publishes when v* style tags are built: release secrets use GitHub tag and deployment environment protection.

Container images are based on the Chainguard Static container and run as non-root. They are published to the chinmina/chinmina-bridge repository.

Closes #13

Summary by CodeRabbit

  • New Features

    • Implemented a new automated release workflow to enhance software deployment efficiency.
    • Updated testing workflow to respond to changes in the main branch, ensuring more reliable builds.
  • Chores

    • Configured automated release settings and testing parameters for the chinmina-bridge binary across various platforms.

Use the long form instead.
Copy link

coderabbitai bot commented May 6, 2024

Walkthrough

Enhancing software development workflows through efficient updates to GitHub Actions workflows and GoReleaser configurations for streamlined version control, deployment, and testing processes.

Changes

File Path Change Summary
.github/workflows/... GitHub Actions workflows adjusted for version tags and branch triggers, integrating DockerHub via GoReleaser.
.goreleaser.yaml Configuration added for building, releasing, and testing chinmina-bridge, specifying platforms and release settings.

🐇💻
A hop, a skip, a code deploy,
In the land of Git, there's much to enjoy.
Tags push, branches set,
Automated flows we won't regret.
Cheers to smooth releases, oh boy!


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

codecov bot commented May 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 35.79%. Comparing base (acd07a0) to head (7a7d49f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #22   +/-   ##
=======================================
  Coverage   35.79%   35.79%           
=======================================
  Files          13       13           
  Lines         556      556           
=======================================
  Hits          199      199           
  Misses        343      343           
  Partials       14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between acd07a0 and b3547ee.
Files selected for processing (3)
  • .github/workflows/release.yaml (1 hunks)
  • .github/workflows/test.yaml (1 hunks)
  • .goreleaser.yaml (1 hunks)
Files skipped from review due to trivial changes (2)
  • .github/workflows/release.yaml
  • .github/workflows/test.yaml
Additional comments not posted (6)
.goreleaser.yaml (6)

3-13: The build configuration looks good and covers common platforms and architectures.


15-16: Checksum configuration is appropriately set with a clear and standard naming convention.


18-20: Archive configuration is correctly set with a dynamic naming template that enhances clarity.


22-24: Changelog configuration is well-set using GitHub's native tools and logical sorting order.


26-27: Release configuration smartly uses automatic determination for pre-releases, which is a good use of automation.


30-65: Container configuration is well-defined, using a secure base image and appropriate tagging rules. Ensure the tagging logic works as expected in different scenarios.

Verification successful

The tagging logic in the .goreleaser.yaml file has been verified and is correctly implemented to handle both release and pre-release scenarios as intended. The use of conditional tags ensures appropriate behavior depending on the release type.

  • .goreleaser.yaml: Correctly uses conditional logic for tagging in different release scenarios.
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the tagging logic in different scenarios.

# Test: Search for the tagging logic usage. Expect: Correct behavior in both release and pre-release scenarios.
rg --type yaml $'tags:'

Length of output: 49



Script:

#!/bin/bash
# Description: Examine the tagging logic in `.goreleaser.yaml` to ensure it behaves correctly in both release and pre-release scenarios.

# Display the lines around the 'tags:' entry to understand the logic applied.
rg --type yaml --context 10 'tags:' .goreleaser.yaml

Length of output: 540

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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between acd07a0 and c168a0c.
Files selected for processing (3)
  • .github/workflows/release.yaml (1 hunks)
  • .github/workflows/test.yaml (1 hunks)
  • .goreleaser.yaml (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • .github/workflows/release.yaml
  • .github/workflows/test.yaml
  • .goreleaser.yaml

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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between acd07a0 and 1c8ba93.
Files selected for processing (3)
  • .github/workflows/release.yaml (1 hunks)
  • .github/workflows/test.yaml (1 hunks)
  • .goreleaser.yaml (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • .github/workflows/release.yaml
  • .github/workflows/test.yaml
  • .goreleaser.yaml

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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between acd07a0 and 7a7d49f.
Files selected for processing (3)
  • .github/workflows/release.yaml (1 hunks)
  • .github/workflows/test.yaml (1 hunks)
  • .goreleaser.yaml (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • .github/workflows/release.yaml
  • .github/workflows/test.yaml
  • .goreleaser.yaml

@jamestelfer jamestelfer merged commit c7807c1 into main May 6, 2024
3 of 4 checks passed
@jamestelfer jamestelfer deleted the release branch May 6, 2024 08:08
@jamestelfer jamestelfer added this to the v1 release milestone May 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

DockerHub publishing
1 participant