Releasing a version

Steps to release a new version

1. Pick the version to release, e.g. 14.3.0. Bump the minor or major version instead of the patch if the release has new features or breaking changes. The version in the pom file on master has to end with -SNAPSHOT, or the workflow fails.
2. Go to Actions > Release > Run Workflow, run it on master and enter the version (or run gh workflow run release.yml --ref master -f version=14.3.0). It will:
   1. Set the version in the pom file and the README
   2. Publish the release to Maven Central automatically
   3. Push the v<version> tag and create a draft GitHub release for it with generated notes
   4. Open a "Version Release" PR that bumps the pom to the next -SNAPSHOT version and keeps the README on the released one
3. Merge the PR that was created by the workflow. Its checks wait for approval, since the workflow opened it, so select Approve workflows to run in the merge box first. Once they pass, approve and merge it like any other PR
4. Edit the draft release, add notes about behaviour changes and breaking changes and publish it
5. Update the version on the getting started page of the documentation

Maven Central

Deployments are made to Maven Central on the io.github.graphql-java-kickstart namespace using a user token that is stored as a secret in this Github repositoy (OSS_USER_TOKEN_KEY|PASS) and used during the release Github action.

It is also possible to deploy a snapshot locally by running mvn clean deploy with .m2/setting.xml configured to use the same token:

  <servers>
    <server>
      <id>central</id>
      <username>{token-user}</username>
      <password>{token-pass}</password>
    </server>
  </servers>