Explorar o código

Merge pull request #4051 from shin-/update-release-process

Update release process document to account for recent changes.
Joffrey F %!s(int64=8) %!d(string=hai) anos
pai
achega
47b672e393
Modificáronse 1 ficheiros con 33 adicións e 29 borrados
  1. 33 29
      project/RELEASE-PROCESS.md

+ 33 - 29
project/RELEASE-PROCESS.md

@@ -20,18 +20,30 @@ release.
 
 As part of this script you'll be asked to:
 
-1.  Update the version in `docs/install.md` and `compose/__init__.py`.
+1.  Update the version in `compose/__init__.py` and `script/run/run.sh`.
 
-    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.0-rc1`.
 
 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.
 
-    Bug fixes are worth mentioning if it's likely that they've affected lots of people, or if they were regressions in the previous version.
+    Bug fixes are worth mentioning if it's likely that they've affected lots
+    of people, or if they were regressions in the previous version.
 
     Improvements to the code are not worth mentioning.
 
+3.  Create a new repository on [bintray](https://bintray.com/docker-compose).
+    The name has to match the name of the branch (e.g. `bump-1.9.0`) and the
+    type should be "Generic". Other fields can be left blank.
+
+4.  Check that the `vnext-compose` branch on
+    [the docs repo](https://github.com/docker/docker.github.io/) has
+    documentation for all the new additions in the upcoming release, and create
+    a PR there for what needs to be amended.
+
 
 ## When a PR is merged into master that we want in the release
 
@@ -55,8 +67,8 @@ Check out the bump branch and run the `build-binaries` script
 
 When prompted build the non-linux binaries and test them.
 
-1.  Download the osx binary from Bintray. Make sure that the latest build has
-    finished, otherwise you'll be downloading an old binary.
+1.  Download the osx binary from Bintray. Make sure that the latest Travis
+    build has finished, otherwise you'll be downloading an old binary.
 
     https://dl.bintray.com/docker-compose/$BRANCH_NAME/
 
@@ -67,22 +79,24 @@ When prompted build the non-linux binaries and test them.
 3.  Draft a release from the tag on GitHub (the script will open the window for
     you)
 
-    In the "Tag version" dropdown, select the tag you just pushed.
-
-4.  Paste in installation instructions and release notes. Here's an example - change the Compose version and Docker version as appropriate:
+    The tag will only be present on Github when you run the `push-release`
+    script in step 7, but you can pre-fill it at that point.
 
-        Firstly, note that Compose 1.5.0 requires Docker 1.8.0 or later.
+4.  Paste in installation instructions and release notes. Here's an example -
+    change the Compose version and Docker version as appropriate:
 
-        Secondly, if you're a Mac user, the **[Docker Toolbox](https://www.docker.com/toolbox)** will install Compose 1.5.0 for you, alongside the latest versions of the Docker Engine, Machine and Kitematic.
+        If you're a Mac or Windows user, the best way to install Compose and keep it up-to-date is **[Docker for Mac and Windows](https://www.docker.com/products/docker)**.
 
-        Otherwise, you can use the usual commands to install/upgrade. Either download the binary:
+        Note that Compose 1.9.0 requires Docker Engine 1.10.0 or later for version 2 of the Compose File format, and Docker Engine 1.9.1 or later for version 1. Docker for Mac and Windows will automatically install the latest version of Docker Engine for you.
 
-            curl -L https://github.com/docker/compose/releases/download/1.5.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
-            chmod +x /usr/local/bin/docker-compose
+        Alternatively, you can use the usual commands to install or upgrade Compose:
 
-        Or install the PyPi package:
+        ```
+        curl -L https://github.com/docker/compose/releases/download/1.9.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
+        chmod +x /usr/local/bin/docker-compose
+        ```
 
-            pip install -U docker-compose==1.5.0
+        See the [install docs](https://docs.docker.com/compose/install/) for more install options and instructions.
 
         Here's what's new:
 
@@ -99,6 +113,8 @@ When prompted build the non-linux binaries and test them.
         ./script/release/push-release
 
 
+8.  Merge the bump PR.
+
 8.  Publish the release on GitHub.
 
 9.  Check that all the binaries download (following the install instructions) and run.
@@ -107,19 +123,7 @@ When prompted build the non-linux binaries and test them.
 
 ## If it’s a stable release (not an RC)
 
-1. Merge the bump PR.
-
-2. Make sure `origin/release` is updated locally:
-
-        git fetch origin
-
-3. Update the `docs` branch on the upstream repo:
-
-        git push [email protected]:docker/compose.git origin/release:docs
-
-4. Let the docs team know that it’s been updated so they can publish it.
-
-5. Close the release’s milestone.
+1. Close the release’s milestone.
 
 ## If it’s a minor release (1.x.0), rather than a patch release (1.x.y)