Content
Updated by Markus Kahl about 20 hours ago
**Prerequisites**
* Clone and install [https://github.com/opf/openproject-devkit](https://github.com/opf/openproject-devkit)
* Set up and authorize [https://cli.github.com/](https://cli.github.com/) with a `repo` scope token with access to the openproject, release-api and openproject-website repositories. This is used for:
* automatic triggering of the website documentation build
* automatic publishing of the release entry on GitHub
* Create an access token for the OpenProject community, and export that using `export OPENPROJECT_API_TOKEN="token"`. This is used for:
* This is used for automatic creation of the release news
**Releasing**
Creating a new patch release boils down to running `bin/opdev release X.Y.Z`, which does the following:
* Create a `workspace/` directory where openproject core and release api are cloned. Then the following release actions are done locally::
* Release core stable/X from release/X.Y
* Tag stable/X with vX.Y.Z
* Bump release/X.Y to X.Y.(Z+1)
* Create a release-api entry
* Creating and publishing release notes
So, to actually run this command to release OpenProject@vX.Y.Z you use:
`./bin/opdev release X.Y.Z`
Once that command has completed, you can inspect your local workspace to make sure the release is complete and then redo it with push enabled:
`./bin/opdev release --push X.Y.Z`
**Release Checklist**
* [x] [ ] Release added to [https://github.com/opf/openproject/releases](https://github.com/opf/openproject/releases)
* [x] [ ] Release added to https://community.openproject.org/projects/openproject/news
* [x] [ ] Confirmed release API up to date [https://releases.openproject.com/v1/check.svg?version=15.0.2&type=packager](https://releases.openproject.com/v1/check.svg?version=15.0.2&type=packager) [https://releases.openproject.com/v1/check.svg?version=X.Y.Z&type=packager](https://releases.openproject.com/v1/check.svg?version=10.4.0&type=packager)
* [ ] Confirmed packages completed at https://packager.io/gh/opf/openproject/refs/stable/15 https://packager.io/gh/opf/openproject/refs/stable/X
* [ ] Confirmed docker tags built at [https://github.com/opf/openproject/actions/workflows/docker.yml](https://github.com/opf/openproject/actions/workflows/docker.yml)
* [ ] Confirmed Helm chart PR is green in merged (https://github.com/opf/helm-charts/pulls)
* Clone and install [https://github.com/opf/openproject-devkit](https://github.com/opf/openproject-devkit)
* Set up and authorize [https://cli.github.com/](https://cli.github.com/) with a `repo` scope token with access to the openproject, release-api and openproject-website repositories. This is used for:
* automatic triggering of the website documentation build
* automatic publishing of the release entry on GitHub
* Create an access token for the OpenProject community, and export that using `export OPENPROJECT_API_TOKEN="token"`. This is used for:
* This is used for automatic creation of the release news
**Releasing**
Creating a new patch release boils down to running `bin/opdev release X.Y.Z`, which does the following:
* Create a `workspace/` directory where openproject core and release api are cloned. Then the following release actions are done locally::
* Release core stable/X from release/X.Y
* Tag stable/X with vX.Y.Z
* Bump release/X.Y to X.Y.(Z+1)
* Create a release-api entry
* Creating and publishing release notes
So, to actually run this command to release OpenProject@vX.Y.Z you use:
`./bin/opdev release X.Y.Z`
Once that command has completed, you can inspect your local workspace to make sure the release is complete and then redo it with push enabled:
`./bin/opdev release --push X.Y.Z`
**Release Checklist**
* [x]
* [x]
* [x]
* [ ] Confirmed packages completed at https://packager.io/gh/opf/openproject/refs/stable/15
* [ ] Confirmed docker tags built at [https://github.com/opf/openproject/actions/workflows/docker.yml](https://github.com/opf/openproject/actions/workflows/docker.yml)
* [ ] Confirmed Helm chart PR is green in merged (https://github.com/opf/helm-charts/pulls)