Skip to content

Commit

Permalink
Release documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
svanteschubert committed Dec 20, 2023
1 parent c10ed6d commit a244914
Showing 1 changed file with 2 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -104,14 +104,15 @@ There are two kinds of releases a quick SNAPSHOT release, where the SNAPSHOT wil
```

This will start the interactive release preparation. You need to supply Maven with the versions of the release. "release version" should be the version of the intended release (recommended value should be fine). "SCM release tag or label" should include the RC version (e.g. odftoolkit-0.10.0). "new development version" should be the current SNAPSHOT version.
Strangely, it already does two commits one for the release and one for the follow-up SNAPSHOT - even the release has not succeded now. 'mvn release:perform' will check out the first commit again (a bit suboptimal IMHO).

1. **Perform the release**

```shell
mvn release:perform
```

This will checkout the tag to the target directory, build and package everything and upload the artifacts to the staging repository.
"mvn release:perform" will checkout the tag (created by mvn release:prepare) to the target directory, build and package everything and upload the artifacts to the staging repository.
Users will download the mirrored release artifacts from machines outside TDF control. Users need to verify that the copy downloaded is identical to the original. Mirrored copies of checksums, KEYS and signature files (.asc and .md5 files) will be present on the mirrors but must never be used for verification. So, all links from the project website to signatures, sums and [KEYS](https://github.com/tdf/odftoolkit/blob/master/KEYS) need to refer to the original documents on GitHub. See release signing guide for more information (from Apache).

1. **Add the Git tag manually after branch rebase**
Expand Down

0 comments on commit a244914

Please sign in to comment.