- In GitHub, go to the Prepare Release Workflow.
- Click Run workflow drop-down.
- Optional: Enter the desired version in the Release version field. If not provided, the current snapshot version will be used.
- Optional: Enter the branch name to release from. By default, this is our
mainbranch.
When the workflow runs successfully, it will have created a RELEASE-X.Y.Z branch.
Additionally, the workflow will create a few PRs:
- One to update our JavaDocs in the Documentation Repository
- Another one to update our release notes, also in the Documentation Repository
- Note As we are splitting our release notes every 15 minor versions, some manual adjustment might be needed to both
index.jsxandrelease-notes.mdx
- Note As we are splitting our release notes every 15 minor versions, some manual adjustment might be needed to both
- A third one for the actual changes in the Code Repository
Lastly, the workflow also creates a new draft release and an according tag. All of these things will be linked in the Code PR, so that they can be found easily.
Follow the steps outlined in the PR description in order.
As the second to last step, you will trigger the Perform Release Workflow.
This workflow will take care of merging the PRs and creates a staging release in Sonatype.
As the very last step, once the Perform Release workflow has finished successfully, you need to log into Sonatype and publish the staging release using the Technical User for Releases account.
That's it! The new version should be available for consumers within a few hours.