Improve our release process with goreleaser #5813
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
niccoloraspa
added
A:no-changelog
V:state/compatible/backport
|
If you are curious these are the logs: Logs: |
added 2 commits
July 11, 2023 17:32
czarcas7ic
reviewed
Jul 24, 2023
| name_template: "checksums.txt" | ||
| algorithm: sha256 | ||
|
|
||
| # Docs: https://goreleaser.com/customization/homebrew/ |
There was a problem hiding this comment.
oh sweet we have an osmosis brew??
czarcas7ic
reviewed
Jul 24, 2023
Comment on lines
+241
to
+254
| # Docs: https://goreleaser.com/customization/announce/ | ||
| # | ||
| # We could automatically announce the release in | ||
| # - discord | ||
| # - slack | ||
| # - webhooks | ||
| # - telegram | ||
| # | ||
| # announce: | ||
| # discord: | ||
| # enabled: true | ||
| # message_template: 'New {{.Tag}} is out!' |
There was a problem hiding this comment.
Can we track this in an issue, seems like it would be super useful.
czarcas7ic
approved these changes
Jul 24, 2023
mergify bot
pushed a commit
that referenced
this pull request
Jul 24, 2023
* Add .goreleaser.yaml * Add complete .goreleaser.yaml * use tar.gz as a format * Update docker description (cherry picked from commit ccd779d)
mattverse
pushed a commit
that referenced
this pull request
Jul 24, 2023
* Add .goreleaser.yaml * Add complete .goreleaser.yaml * use tar.gz as a format * Update docker description (cherry picked from commit ccd779d) Co-authored-by: Niccolo Raspa <[email protected]>
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
This PR introduces the
.goreleaser.yamlconfiguration file and sets up the release process for the project osmosisd.Goreleaser is a popular tool used in the Go ecosystem to automate the build and release workflow for Go projects. It simplifies the process of building binaries, creating archives, generating checksums, and publishing releases across multiple platforms and architectures.
The
goreleaser.yamlfile included in this PR defines the configuration for the release process ofosmosisd.Let's summarize the key elements of the configuration:
Project Information:
project_name: Specifies the name of the project asosmosisd.Environment Variables:
Builds:
The configuration defines four build targets, each specifying different operating systems and architectures:
osmosisd-darwin-amd64: Builds theosmosisdbinary for macOS (darwin) on AMD64 architecture.osmosisd-darwin-arm64: Builds theosmosisdbinary for macOS (darwin) on ARM64 architecture.osmosisd-linux-amd64: Builds theosmosisdbinary for Linux on AMD64 architecture.osmosisd-linux-arm64: Builds theosmosisdbinary for Linux on ARM64 architecture.For each build, the configuration specifies the necessary build commands, hooks, environment variables, Go compiler options, flags, and linker flags.
Universal Binaries:
osmosisd-darwin-universal: Creates a universal binary that includes both the macOS (darwin) AMD64 and ARM64 builds.Archives:
The configuration defines an archive configuration named
zippedthat generates zip archives for the universal darwin binary and Linux AMD64/ARM64 binaries.Checksums:
osmosisd-{{ .Version }}-checksums.txtusing the SHA256 algorithm.Brew Formula:
osmosisdcalledosmosisd. The formula installs theosmosisdbinary and includes tests and installation instructions. This would allow user to installosmosisdwithbrew install osmosisdRelease Configuration:
There a lot of options that we could customize in this file.
For example we could automatically announce on Discord, Slack, Twitter, etc.. once the release is done: https://goreleaser.com/customization/announce/
Testing and Verifying
I have used this
.goreleaser.yamlto create the following release in my local fork: Link to ReleaseTo replicate the release process, execute the following command:
Fork the osmosis repo with all the tags
Clone the repo and select the tag
Copy this
.goreleaser.yamlEdit the
.goreleaser.yamlto avoid creating a release in the real repository.goreleaser-cross:docker run -e GITHUB_TOKEN=<GITHUB_TOKEN_WITH_REPO_ACCESS> -v /var/run/docker.sock:/var/run/docker.sock -v pwd:/go/src/osmosisd -w /go/src/osmosisd ghcr.io/goreleaser/goreleaser-cross:v1.20.5 release --cleanReplace
<GITHUB_TOKEN_WITH_REPO_ACCESS>with an actual GitHub token that has access to the repository.Documentation and Release Note
Unreleasedsection ofCHANGELOG.md?Where is the change documented?
x/{module}/README.md)