The branch master has been updated via 9d9c86fe443afcb8a13a8ae40b91674a6afefcd3 (commit) from e1fc98e1c15660ad4d51526cc6da9c44e2f49cd4 (commit)
- Log ----------------------------------------------------------------- commit 9d9c86fe443afcb8a13a8ae40b91674a6afefcd3 Author: Richard Levitte <levi...@openssl.org> Date: Tue Nov 17 11:28:23 2020 +0100 release-tools: Separate do-release.pl docs from mkrelease.pl docs Reviewed-by: Matt Caswell <m...@openssl.org> (Merged from https://github.com/openssl/tools/pull/74) ----------------------------------------------------------------------- Summary of changes: release-tools/DO-RELEASE.md | 34 ++++++++++++++++++++++++++++++++++ release-tools/MKRELEASE.md | 35 ----------------------------------- release-tools/README.md | 2 +- 3 files changed, 35 insertions(+), 36 deletions(-) create mode 100644 release-tools/DO-RELEASE.md diff --git a/release-tools/DO-RELEASE.md b/release-tools/DO-RELEASE.md new file mode 100644 index 0000000..636d60b --- /dev/null +++ b/release-tools/DO-RELEASE.md @@ -0,0 +1,34 @@ +# Documentation on the do-release script + +The do-release.pl script copies distributions from the temporary holding area +to the http and ftp areas. It it intended to be run as the `openssl` user on +dev.openssl.org. + +It does the following: + +1. Copy OpenSSL release files from the holding area to the http and ftp + locations: currently /v/openssl/www/source and /v/openssl/ftp/source +2. Move OpenSSL release files from holding area to ~openssl/dist/old By + doing this the script wont try and make a release again with old files. +3. Mail the release message. This is sent to openssl-project openssl-users + and openssl-announce (it needs to be approved in openssl-announce). The + subject line is `OpenSSL version xxx released`. + +## do-release options + +- `--copy`<br> + Copy files to http and ftp directories. **You will have to manually move + the OLD files to old/<SUBDIR> directories.** + +- `--move`<br> + Move files from holding area to ~openssl/dist/old + +- `--mail`<br> + Send out announcement email: if this option is not given, the command you + need to call to send the release mail will be printed out. + +- `--full-release`<br> + Perform all operations for a release (copy, move and mail). + +Note: because several of these options are irreversible they have to be +explicitly included. diff --git a/release-tools/MKRELEASE.md b/release-tools/MKRELEASE.md index 3c8c1e4..be9e73e 100644 --- a/release-tools/MKRELEASE.md +++ b/release-tools/MKRELEASE.md @@ -136,38 +136,3 @@ For local testing, you can do something like this: - `--branch-version=version`<br> Use branch `version` instead of the one autodetected for the current branch. This option is not normally needed. - -# The do-release script - -The do-release.pl script copies distributions from the temporary holding area -to the http and ftp areas. It it intended to be run as the `openssl` user on -dev.openssl.org. - -It does the following: - -1. Copy OpenSSL release files from the holding area to the http and ftp - locations: currently /v/openssl/www/source and /v/openssl/ftp/source -2. Move OpenSSL release files from holding area to ~openssl/dist/old By - doing this the script wont try and make a release again with old files. -3. Mail the release message. This is sent to openssl-dev openssl-users and - openssl-announce (it needs to be approved in openssl-announce). The - subject line is `OpenSSL version xxx released`. - -## do-release options - -- `--copy`<br> - Copy files to http and ftp directories. **You will have to manually move - the OLD files to old/<SUBDIR> directories.** - -- `--move`<br> - Move files from holding area to ~openssl/dist/old - -- `--mail`<br> - Send out announcement email: if this option is not given, the command you - need to call to send the release mail will be printed out. - -- `--full-release`<br> - Perform all operations for a release (copy, move and mail). - -Note: because several of these options are irreversible they have to be -explicitly included. diff --git a/release-tools/README.md b/release-tools/README.md index ad03508..dc18f74 100644 --- a/release-tools/README.md +++ b/release-tools/README.md @@ -114,7 +114,7 @@ associated files should be in ~openssl/dist/new. They should be owned by the openssl userid and world-readable. Copy the tarballs to appropriate directories. This can be -done using the do-release.pl script. See MKRELEASE.md for a description of +done using the do-release.pl script. See DO-RELEASE.md for a description of the options. For example: sudo -u openssl perl ~openssl/do-release.pl --copy --move