Document ./release.sh new snapshot (#11730)

changelog_begin
changelog_end
This commit is contained in:
Stefano Baghino 2021-11-17 09:10:43 +01:00 committed by GitHub
parent 122a4ccd0d
commit bf4f9f7eea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -24,6 +24,11 @@ patches we backport to the 1.0 release branch).
If you are manually creating the PR for an out-of-schedule snapshot, start If you are manually creating the PR for an out-of-schedule snapshot, start
_from latest `main`_ and run _from latest `main`_ and run
``` ```
./release.sh new snapshot
```
If you want to have a stricter control over the specific commit and version
prefix the command can also be used as follows:
```
./release.sh snapshot <sha> <prefix> ./release.sh snapshot <sha> <prefix>
``` ```
for example: for example:
@ -31,7 +36,10 @@ patches we backport to the 1.0 release branch).
$ ./release.sh snapshot cc880e2 0.1.2 $ ./release.sh snapshot cc880e2 0.1.2
cc880e290b2311d0bf05d58c7d75c50784c0131c 0.1.2-snapshot.20200513.4174.0.cc880e29 cc880e290b2311d0bf05d58c7d75c50784c0131c 0.1.2-snapshot.20200513.4174.0.cc880e29
``` ```
Then open a PR _to be merged to `main`_ (even if it's for a maintenance release) The former version of the command defaults to `HEAD` as the commit and tries
to figure out the version prefix to use based on the first line of the `LATEST`
file. This also mean that you will have to use the latter form for maintenance releases.
Once the script has run, open a PR _to be merged to `main`_ (even if it's for a maintenance release)
with the changed `LATEST` file, add the line produced by the `release.sh` with the changed `LATEST` file, add the line produced by the `release.sh`
invocation in a meaningful position (if youre not sure, [semver](https://semver.org/) ordering is invocation in a meaningful position (if youre not sure, [semver](https://semver.org/) ordering is
probably the right thing to do) and add the `Standard-Change` label. It probably the right thing to do) and add the `Standard-Change` label. It