1
1
# README - OTP Custom/Fork Release Scripts
2
2
3
- ** Note! This describes how you can set up and release OTP in your own GitHub fork, not how OTP in the
4
- main repo is released.**
3
+ ** Note! This describes how you can set up and release OTP in your own GitHub fork, not how OTP in
4
+ the main repo is released.**
5
5
6
6
7
7
## Introduction
@@ -24,22 +24,23 @@ The release is made in the `release branch` in the forked git repository. The re
24
24
based on the ` base revision ` - a branch, tag or commit, for example ` otp/dev-2.x ` .
25
25
26
26
1 . The release script will start by _ resetting_ the ` release branch ` to the given ` base revision ` .
27
- ** Nothing is kept from previous releases.**
27
+ ** Nothing is kept from previous releases.**
28
28
2 . Then all pending PRs tagged with your ` TEST ` label is meged in. The name of the label is
29
- configured in the ` custom-release-env.json ` file.
29
+ configured in the ` custom-release-env.json ` file.
30
30
3 . Then all your extension branches are meged in. These are normally branchech with your deployment
31
- config and GitHub workflow files. The name of these branches is configured in the
32
- ` custom-release-env.json ` file.
31
+ config and GitHub workflow files. The name of these branches is configured in the
32
+ ` custom-release-env.json ` file.
33
33
4 . The ` custom-release-extension ` script is run, if it exist. For example you may delete
34
- workflow scripts comming from the upstream ` base revision ` .
34
+ workflow scripts comming from the upstream ` base revision ` .
35
35
5 . The old release is then merged with an _ empty merge_ , this is done to create a continuous line
36
- of releases in the release branch for easy viewing and navigation of the git history. Nothing
37
- from the previous release is copied into the new release. We call this an _ empty merge_ .
38
- 6 . Then the script update the _ otp-serialization-version-id_ and OTP _ version_ . Each release is
39
- given a unique version number specific to your fork, like ` v2.7.0-MY_ORG-1 ` . The release script
40
- uses both the git history and the GitHub GraphQL API (PRs labeled ` bump serialization id ` ) to
41
- resolve the versions numbers.
42
- 7 . The script finally push the release.
36
+ of releases in the release branch for easy viewing and navigation of the git history. Nothing
37
+ from the previous release is copied into the new release. We call this an _ empty merge_ .
38
+ 6 . Then the script update the _ otp-serialization-version-id_ and the OTP _ version_ in the pom.xml
39
+ file. Each release is given a unique version number specific to your fork, like
40
+ ` v2.7.0-MY_ORG-1 ` . The release script uses both the git history and the GitHub GraphQL API
41
+ (PRs labeled ` bump serialization id ` ) to resolve the serialization version number.
42
+ 7 . Finally the release is tagged and pushed to the remote Git repository. The repository is
43
+ configured in the ` custom-release-env.json ` file.
43
44
44
45
Do not worry about deleting more recent versions, the release script will preserve the history so
45
46
nothing is lost.
0 commit comments