Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] add RELEASING.md #1387

Merged
merged 1 commit into from
Mar 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@

### Versioning

Version = MAJOR (>=1 year), MINOR (>= 1 month), PATCH

Version Status = Dev / Release


### Git

Branches
develop: active development branch
master: latest release
vMAJOR.MINOR: release branch

Tags
vMAJOR.MINOR.PATCH: tag for each release


### Release Process

- Check if we need to upgrade some dependencies
- CMake all-in-one
- CMakeLists.txt in the root folder (use docker/check_dependencies_releases.py)
- Push updates to https://hub.docker.com/r/alicevision/alicevision-deps/tags
- Check vcpkg
- Update https://github.com/alicevision/vcpkg branch: alicevision_master
- Upload result on gdrive and update INSTALL.md
- Update INSTALL.md
- Update minimal versions if needed
- Update vcpkg install command if needed
- Source code
- Create branch from develop: "rcMAJOR.MINOR"
- Modify version in code, version status to RELEASE (src/aliceVision/version.hpp)
- 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 & update pre-compiled dependencies on gdrive if needed
- 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 DEV
- PR to develop: "Start Development MAJOR.MINOR"


### 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 (src/aliceVision/version.hpp)
- Update release note
- Build step
- Uploads
- Github release note