From 94a6db62444f020a41e22f4d234270f790dee737 Mon Sep 17 00:00:00 2001 From: Duke Leto Date: Sun, 15 Dec 2019 20:45:26 -0500 Subject: [PATCH] Hush does not use this process --- doc/hotfix-process.md | 74 ------------------------------------------- 1 file changed, 74 deletions(-) delete mode 100644 doc/hotfix-process.md diff --git a/doc/hotfix-process.md b/doc/hotfix-process.md deleted file mode 100644 index e6ce8a7a2..000000000 --- a/doc/hotfix-process.md +++ /dev/null @@ -1,74 +0,0 @@ -Hotfix Release Process -====================== - -Hotfix releases are versioned by incrementing the build number of the latest -release. For example: - - First hotfix: v1.0.11 -> v1.0.11-1 - Second hotfix: v1.0.11-1 -> v1.0.11-2 - -In the commands below, and are prefixed with a v, ie. -v1.0.11 (not 1.0.11). - -## Create a hotfix branch - -Create a hotfix branch from the previous release tag, and push it to the main -repository: - - $ git branch hotfix- - $ git push 'git@github.com:zcash/zcash' hotfix- - -## Implement hotfix changes - -Hotfix changes are implemented the same way as regular changes (developers work -in separate branches per change, and push the branches to their own repositories), -except that the branches are based on the hotfix branch instead of master: - - $ git checkout hotfix- - $ git checkout -b - -## Merge hotfix PRs - -Hotfix PRs are created like regular PRs, except using the hotfix branch as the -base instead of master. Each PR should be reviewed as normal, and then the -following process should be used to merge: - -- A CI merge build is manually run by logging into the CI server, going to the - pr-merge builder, clicking the "force" button, and entering the following - values: - - - Repository: https://github.com//zcash - - must be in the set of "safe" users as-specified in the CI - config. - - Branch: name of the hotfix PR branch (not the hotfix release branch). - -- A link to the build and its result is manually added to the PR as a comment. - -- If the build was successful, the PR is merged via the GitHub button. - -## Release process - -The majority of this process is identical to the standard release process. -However, there are a few notable differences: - -- When running the release script, use the `--hotfix` flag: - - $ ./zcutil/make-release.py --hotfix - -- To review the automated changes in git: - - $ git log hotfix-..HEAD - -- After the standard review process, use the hotfix merge process outlined above - instead of the regular merge process. - -- When making the tag, check out the hotfix branch instead of master. - -## Post-release - -Once the hotfix release has been created, a new PR should be opened for merging -the hotfix release branch into master. This may require fixing merge conflicts -(e.g. changing the version number in the hotfix branch to match master, if -master is ahead). Such conflicts **MUST** be addressed with additional commits -to the hotfix branch; specifically, the branch **MUST NOT** be rebased on -master.