release.md

Release Process

1. Release Preparation

a. Major/Minor Release

1. Create a release branch from the master with the format release/<major>.<minor> (e.g. release/2.1).

On the release branch:

2. In case any new feature was added, update the feature description in:
   • README.md
   • appinfo/info.xml
3. Update the version in:
   • appinfo/info.xml
   • package.json
4. Add the new release branch in .tx/backport to allow transifex commits.
5. Update CHANGELOG.md with the changes and the version to be released.
6. Update the new release branch in the nightly CI.
7. Perform confirmatory testing (Changelogs) - by the OpenProject team.
8. Perform smoke testing - by the OpenProject team.

b. Patch Release

On the current release branch:

1. Update the patch version in:
   • appinfo/info.xml
   • package.json
2. Update CHANGELOG.md with the changes and the version to be released.
3. Perform confirmatory testing (Changelogs) - by the OpenProject team.
4. Perform smoke testing - by the OpenProject team.

2. Publish Release

Important

The tag MUST follow the following format:

• For release: vX.Y.Z (e.g. v2.1.1)
• For test release: vX.Y.Z-yyyymmdd-nightly (e.g. v2.1.1-20220928-nightly)

1. Tag a commit from the release branch.

   git tag vX.Y.Z -m "vX.Y.Z"
   
   # E.g.:
   # git tag v2.1.1-20220928-nightly -m "v2.1.1-20220928-nightly"

   NOTE: Every tag should be created with a unique commit, or the publish will fail.

2. Push the tag to the auto-release branch.

   git push origin release/<major>.<minor>:auto-release vX.Y.Z
   
   # E.g.:
   # git push origin release/2.1:auto-release v2.1.1-20220928-nightly

3. Approve the deployment in GitHub actions.

4. Check the release on Nextcloud app store.

3. After Release

1. Add the release notes to the newly created GitHub release.
2. Merge the necessary commits from the release branch into the master branch.
3. In the master branch, bump the app version to the next version (e.g.: X.(Y+1).0-alpha.1).