Skip to content

Commit 4e0f4aa

Browse files
committed
Split out release process
To aid clarity in how to contribute, I've moved the release process out into it's own RELEASE_PROCESS.md file. The release process info is only relevant for maintainers who are building new releases of compose. Signed-off-by: Mazz Mosley <mazz@houseofmnowster.com>
1 parent c45c16c commit 4e0f4aa

File tree

3 files changed

+41
-35
lines changed

3 files changed

+41
-35
lines changed

CONTRIBUTING.md

-35
Original file line numberDiff line numberDiff line change
@@ -50,38 +50,3 @@ you can specify a test directory, file, module, class or method:
5050
$ script/test tests/unit/cli_test.py
5151
$ script/test tests.integration.service_test
5252
$ script/test tests.integration.service_test:ServiceTest.test_containers
53-
54-
## Building binaries
55-
56-
`script/build-linux` will build the Linux binary inside a Docker container:
57-
58-
$ script/build-linux
59-
60-
`script/build-osx` will build the Mac OS X binary inside a virtualenv:
61-
62-
$ script/build-osx
63-
64-
For official releases, you should build inside a Mountain Lion VM for proper
65-
compatibility. Run the this script first to prepare the environment before
66-
building - it will use Homebrew to make sure Python is installed and
67-
up-to-date.
68-
69-
$ script/prepare-osx
70-
71-
## Release process
72-
73-
1. Open pull request that:
74-
- Updates the version in `compose/__init__.py`
75-
- Updates the binary URL in `docs/install.md`
76-
- Adds release notes to `CHANGES.md`
77-
2. Create unpublished GitHub release with release notes
78-
3. Build Linux version on any Docker host with `script/build-linux` and attach
79-
to release
80-
4. Build OS X version on Mountain Lion with `script/build-osx` and attach to
81-
release as `docker-compose-Darwin-x86_64` and `docker-compose-Linux-x86_64`.
82-
5. Publish GitHub release, creating tag
83-
6. Update website with `script/deploy-docs`
84-
7. Upload PyPi package
85-
86-
$ git checkout $VERSION
87-
$ python setup.py sdist upload

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,8 @@ Contributing
5050
[![Build Status](http://jenkins.dockerproject.org/buildStatus/icon?job=Compose%20Master)](http://jenkins.dockerproject.org/job/Compose%20Master/)
5151

5252
Want to help build Compose? Check out our [contributing documentation](https://github.com/docker/compose/blob/master/CONTRIBUTING.md).
53+
54+
Releasing
55+
---------
56+
57+
Releases are built by maintainers, following an outline of the [release process](https://github.com/docker/compose/blob/master/RELEASE_PROCESS.md).

RELEASE_PROCESS.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Building a Compose release
2+
3+
## Building binaries
4+
5+
`script/build-linux` will build the Linux binary inside a Docker container:
6+
7+
$ script/build-linux
8+
9+
`script/build-osx` will build the Mac OS X binary inside a virtualenv:
10+
11+
$ script/build-osx
12+
13+
For official releases, you should build inside a Mountain Lion VM for proper
14+
compatibility. Run the this script first to prepare the environment before
15+
building - it will use Homebrew to make sure Python is installed and
16+
up-to-date.
17+
18+
$ script/prepare-osx
19+
20+
## Release process
21+
22+
1. Open pull request that:
23+
- Updates the version in `compose/__init__.py`
24+
- Updates the binary URL in `docs/install.md`
25+
- Adds release notes to `CHANGES.md`
26+
2. Create unpublished GitHub release with release notes
27+
3. Build Linux version on any Docker host with `script/build-linux` and attach
28+
to release
29+
4. Build OS X version on Mountain Lion with `script/build-osx` and attach to
30+
release as `docker-compose-Darwin-x86_64` and `docker-compose-Linux-x86_64`.
31+
5. Publish GitHub release, creating tag
32+
6. Update website with `script/deploy-docs`
33+
7. Upload PyPi package
34+
35+
$ git checkout $VERSION
36+
$ python setup.py sdist upload

0 commit comments

Comments
 (0)