-
Notifications
You must be signed in to change notification settings - Fork 251
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Chore: Update stale URL references and add documentation around relea…
…ses (#326) * chore: change URL references to old repo * update README.md
- Loading branch information
1 parent
249e9ad
commit 826d18b
Showing
14 changed files
with
354 additions
and
354 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,19 @@ | ||
# Release process | ||
|
||
Releases are done **manually**. | ||
|
||
Automation may be introduced, but currently they're not that much of an issue. | ||
Releases are done **automatically** via GitHub actions and Release Drafter. | ||
|
||
## Rules | ||
|
||
1. Releases are only created from `master`. | ||
1. `master` is meant to be stable, so before tagging and create a new release, make sure that the CI checks pass. | ||
1. Releases are GitHub releases. | ||
1. Releases are following *semantic versioning*. | ||
1. Releases are to be named in pattern of `vX.Y.Z`. The produced binary artifacts contain the `vX.Y.Z` in their names. | ||
1. Releases are to be named in pattern of `X.Y.Z`. The produced binary artifacts contain the `X.Y.Z` in their names. | ||
1. Changelog must up-to-date with what's going to be released. Check [CHANGELOG](./CHANGELOG.md). | ||
1. **Make sure** to bump the version of `goenv`. Bumping the version of `go-build` is often omitted. | ||
|
||
## Flow | ||
|
||
1. Create a new GitHub release using https://github.com/syndbg/goenv | ||
1. Create a new GitHub release using https://github.com/go-nv/goenv | ||
1. `Tag Version` and `Release Title` are going to be in pattern of `vX.Y.Z`. | ||
1. `Describe this release` (content) is going to link the appropriate [CHANGELOG](./CHANGELOG.md) entry. |
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
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
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
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
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
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
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