Releasing a version

Steps to release a new version

1. Make sure the version in the pom file is the one you want to release and that it ends with -SNAPSHOT, e.g. 14.1.1-SNAPSHOT. Bump the minor or major version instead of the patch if the release has new features or breaking changes. The workflow fails if the version doesn't end with -SNAPSHOT.
2. Update the version in the documentation files
3. Go to Actions > Release > Run Workflow and run the workflow on master. It will:
   1. Publish the release to Maven Central automatically
   2. Push the v<version> tag and create a draft GitHub release for it with generated notes
   3. Open a "Version Release" PR that bumps the version to the next -SNAPSHOT
4. Merge the PR that was created by the workflow. The required checks don't run on PRs opened by the workflow, so this needs an admin merge (gh pr merge <number> --admin --merge)
5. Edit the draft release, add notes about breaking changes and publish it

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>