File: RELEASING.md

package info (click to toggle)
alicevision 3.3.1%2Brepack-2
  • links: PTS, VCS
  • area: contrib
  • in suites: sid
  • size: 34,172 kB
  • sloc: cpp: 142,191; python: 13,724; ansic: 7,937; modula3: 6,977; sh: 163; makefile: 66
file content (66 lines) | stat: -rw-r--r-- 2,141 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

### 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
     - Release result on GitHub repo 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)
     - ```
	   ./github-generate-release-note.py -o alicevision -r AliceVision -m MAJOR.MINOR.PATCH --highlights majorFeature feature --label-include bugfix scope:ci,scope:doc,scope:build sensordb -s updated-asc
	   ```
   - 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