tyler.durden/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2025-07-26 15:14:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update release process docs to use scripts.

Browse Source 
Signed-off-by: Daniel Nephin <dnephin@docker.com>
This commit is contained in:
Daniel Nephin 2015-09-11 02:02:01 -04:00
parent da91b81bb8
commit dc56e4f97e
1 changed files with 10 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
project/RELEASE-PROCESS.md
View File

@ -5,19 +5,18 @@ Building a Compose release
Create a branch, update version, and add release notes by running `make-branch` Create a branch, update version, and add release notes by running `make-branch`
git checkout -b bump-$VERSION $BASE_VERSION ./script/release/make-branch $VERSION [$BASE_VERSION]
`$BASE_VERSION` will default to master. Use the last version tag for a bug fix `$BASE_VERSION` will default to master. Use the last version tag for a bug fix
release. release.
git fetch origin As part of this script you'll be asked to:
git merge --strategy=ours origin/release
3. Update the version in `docs/install.md` and `compose/__init__.py`. 1. Update the version in `docs/install.md` and `compose/__init__.py`.
If the next release will be an RC, append `rcN`, e.g. `1.4.0rc1`. If the next release will be an RC, append `rcN`, e.g. `1.4.0rc1`.
4. Write release notes in `CHANGES.md`. 2. Write release notes in `CHANGES.md`.
Almost every feature enhancement should be mentioned, with the most visible/exciting ones first. Use descriptive sentences and give context where appropriate. Almost every feature enhancement should be mentioned, with the most visible/exciting ones first. Use descriptive sentences and give context where appropriate.
@ -25,38 +24,20 @@ release.
Improvements to the code are not worth mentioning. Improvements to the code are not worth mentioning.
5. Add a bump commit:
git commit -am "Bump $VERSION"
6. Push the bump branch to your fork:
git push --set-upstream $USERNAME bump-$VERSION
7. Open a PR from the bump branch against the `release` branch on the upstream repo, **not** against master.
## When a PR is merged into master that we want in the release ## When a PR is merged into master that we want in the release
1. Check out the bump branch: 1. Check out the bump branch and run the cherry pick script
git checkout bump-$VERSION git checkout bump-$VERSION
./script/release/cherry-pick-pr $PR_NUMBER
2. Cherry-pick the merge commit, fixing any conflicts if necessary: 2. When you are done cherry-picking branches move the bump version commit to HEAD
git cherry-pick -xm1 $MERGE_COMMIT_HASH
3. Add a signoff (it’s missing from merge commits):
git commit --amend --signoff
4. Move the bump commit back to the tip of the branch:
git rebase --interactive $PARENT_OF_BUMP_COMMIT
5. Force-push the bump branch to your fork:
./script/release/rebase-bump-commit
git push --force $USERNAME bump-$VERSION git push --force $USERNAME bump-$VERSION
## To release a version (whether RC or stable) ## To release a version (whether RC or stable)
Check out the bump branch and run the `push-release` script Check out the bump branch and run the `push-release` script