-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GitHub release triggers release workflow
Switch from `push tag` event to `release published`. Also, add docs for release process.
- Loading branch information
1 parent
82d43dc
commit f45dcb1
Showing
2 changed files
with
19 additions
and
3 deletions.
There are no files selected for viewing
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 |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Release process | ||
|
||
Release process is semi-automated through GitHub Actions. This describes the basic steps for a project member to perform a release. | ||
|
||
## Steps | ||
|
||
1. Ensure that the `main` branch is building and that tests are passing. | ||
1. Create a new release on GitHub. | ||
1. The release triggers a GitHub Action workflow. | ||
1. Handcraft and polish some of the release notes (e.g. substitute combined dependency PRs and highlight certain features). | ||
1. Rename existing milestone corresponding to new release and close it. Then create a new `next` milestone. | ||
|
||
## Internal details | ||
|
||
* JReleaser is in charge of steps in Maven Central. |