From a874cee0282ee11ea1e7737729785a65f22d6a14 Mon Sep 17 00:00:00 2001 From: Fabien Castan Date: Wed, 22 Mar 2023 12:28:18 +0100 Subject: [PATCH] [doc] describe releasing process --- RELEASING.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 00000000..7dbd51c2 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,59 @@ + +### Versioning + +Version = MAJOR (>=1 year), MINOR (>= 1 month), PATCH + +Version Status = Develop / Release + + +### Git + +Branches + develop: active development branch + master: latest release + vMAJOR.MINOR: release branch + +Tags + vMAJOR.MINOR.PATCH: tag for each release + + +### Release Process + + - Prepare the AliceVision release: https://github.com/alicevision/AliceVision + - Update INSTALL.md and requirements.txt if needed + - Source code + - Create branch from develop: "rcMAJOR.MINOR" + - Modify version in code, version status to RELEASE (meshroom/__init__.py) + - Create Release note (using https://github.com/cbentejac/github-generate-release-note) + - PR to develop: "Release MAJOR.MINOR" + - Build + - Build docker & push to dockerhub + - Build windows + - Git + - Merge "rcMAJOR.MINOR" into "develop" + - Push "develop" into "master" + - Create branch: vMAJOR.MINOR + - Create tag: vMAJOR.MINOR.PATCH + - Create branch from develop: "startMAJOR.MINOR" + - Upload binaries on fosshub + - Fill up Github release note + - Prepare "develop" for new developments + - Upgrade MINOR and reset version status to Develop + - PR to develop: "Start Development MAJOR.MINOR" + - Communication + - Email on mailing-list: alicevision@googlegroups.com + - Message on linkedin: https://www.linkedin.com/groups/13573776 + - Message on twitter: https://twitter.com/alicevision_org + +### Upgrade a Release with a PATCH version + + - Source code + - Create branch from rcMAJOR.MINOR: "rcMAJOR.MINOR.PATCH" + - Cherry-pick specific commits or rebase required PR + - Modify version in code + - Update release note + - Build step + - Uploads + - Github release note + - Email on mailing-list +