From f45dcb1bbfccc20f6177ecc86d8ee339778d3f0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edd=C3=BA=20Mel=C3=A9ndez?= Date: Fri, 6 Oct 2023 15:56:42 -0600 Subject: [PATCH] GitHub release triggers release workflow Switch from `push tag` event to `release published`. Also, add docs for release process. --- .github/workflows/release.yml | 7 ++++--- RELEASING.md | 15 +++++++++++++++ 2 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 RELEASING.md diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 35ab808..0a942ad 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -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 diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..589b9c3 --- /dev/null +++ b/RELEASING.md @@ -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.