Skip to content

Commit

Permalink
GitHub release triggers release workflow
Browse files Browse the repository at this point in the history
Switch from `push tag` event to `release published`. Also, add docs
for release process.
  • Loading branch information
eddumelendez committed Oct 6, 2023
1 parent 82d43dc commit f45dcb1
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
7 changes: 4 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
name: Publish package to the Maven Central Repository

on:
push:
tags:
- v*
release:
types: [published]

jobs:
publish:
runs-on: ubuntu-latest
Expand Down
15 changes: 15 additions & 0 deletions RELEASING.md
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.

0 comments on commit f45dcb1

Please sign in to comment.