Content
Updated by Oliver Günther about 1 year ago
**Prerequisites**
* Clone and install [https://github.com/opf/openproject-devkit](https://github.com/opf/openproject-devkit)
**Releasing**
Creating a new 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 (if not already present)
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 as news to https://community.openproject.org/projects/openproject/news/new
* [x] Confirmed release API up to date [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)
* [x] [ ] Confirmed packages completed at https://packager.io/gh/opf/openproject/refs/stable/X
* [x] [ ] Confirmed docker tags built at https://hub.docker.com/r/openproject/community/
* [x] MAJOR VERSIONS ONLY: Updated tag in docker-compose.yml [https://github.com/opf/openproject-deploy/blob/stable/11/compose/docker-compose.yml#L14](https://github.com/opf/openproject-deploy/blob/stable/11/compose/docker-compose.yml#L14)
* Clone and install [https://github.com/opf/openproject-devkit](https://github.com/opf/openproject-devkit)
**Releasing**
Creating a new 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 (if not already present)
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 as news to https://community.openproject.org/projects/openproject/news/new
* [x] Confirmed release API up to date [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)
* [x]
* [x]
* [x] MAJOR VERSIONS ONLY: Updated tag in docker-compose.yml [https://github.com/opf/openproject-deploy/blob/stable/11/compose/docker-compose.yml#L14](https://github.com/opf/openproject-deploy/blob/stable/11/compose/docker-compose.yml#L14)