z fix and readme changes

Author: CoderDake

tool/README.md

@@ -19,98 +19,41 @@ Make sure:
 
 ### Prepare the release
 
-#### Create a branch for your release.
-
-```shell
-cd ~/path/to/devtools
-```
-
-```shell
-git checkout master && \
-git pull upstream master && \
-git checkout -b release_$(date +%s);
-```
 
 #### Update the DevTools version number
 
-##### Releasing a clean version
-Run the `tool/update_version.dart` script to update the DevTools version.
-- When doing a release, the pre-releases can be stripped with:
-   ```shell
-   dart tool/update_version.dart auto --type release
-   ```
-- Create a PR with this cleaned version number to denote the official release of Devtools under that number
-
-Verify:
-* that this script updated the pubspecs under packages/
-* updated all references to those packages.
-*  make sure that the version constant in `packages/devtools_app/lib/devtools.dart` was updated
+- Make sure your working branch is clean
+- Run the `tool/release_helper.sh` script with `minor` or `major`.
+   `./tool/release_helper.sh [minor|major]`
+- This creates 2 branches for you:
+    - Clean Branch
+    - Next Branch
+- You will need to prepare and submit both of these branches, when you are doing a full release.
+- ** For your convenience, the `tool/release_helper.sh` script exports the followinging two variables to the terminal it is run in:**
+  - `$DEVTOOLS_CLEAN_BRANCH`
+  - `$DEVTOOLS_NEXT_BRANCH`
+
+#### Verify the version changes
+> For both the $DEVTOOLS_CLEAN_BRANCH and the $DEVTOOLS_NEXT_BRANCH branches
+
+Verify the version changes:
+- that release_helper.sh script updated the pubspecs under packages/
+- updated all references to those packages.
+- make sure that the version constant in `packages/devtools_app/lib/devtools.dart` was updated
 
 These packages always have their version numbers updated in lock, so we don't have to worry about versioning.
 
-##### Updating to the next version
-After merging a cleaned version of the current release, you can then perform a `patch`, `minor`, or `major` update.
-This version can be pushed up in a separate PR to denote the start of this next version.
+#### Manually review the CHANGELOG.md
+> For both the $DEVTOOLS_CLEAN_BRANCH and the $DEVTOOLS_NEXT_BRANCH branches
 
-> NOTE: In the future these two released commits will automatically be handled by GitHub.
-
-- For regular monthly releases, use `minor`:
-   ```shell
-   dart tool/update_version.dart auto --type minor
-   ```
-- To manually set the version:
-   ```shell
-   dart tool/update_version.dart manual --new-version 1.2.3
-   ```
-- To automatically update the version by `major`, `minor`, `patch`, or `dev`:
-   ```shell
-   dart tool/update_version.dart auto --type patch
-   ```
-- Pre-release versions can be stripped with:
-   ```shell
-   dart tool/update_version.dart auto --type release
-   ```
-
-#### Update the CHANGELOG.md (for non-dev releases)
-
-* Use the tool `generate-changelog` to automatically update the `packages/devtools/CHANGELOG.md` file.
-
-   ```shell
-   cd ~/path/to/devtools && \
-   dart tool/bin/repo_tool.dart generate-changelog;
-   ```
-
-* The `generate-changelog` script is
-intended to do the bulk of the work, but still needs manual review.
 * Verify
    * that the version for the CHANGELOG entry was correctly generated
    * that the entries don't have any syntax errors.
 
-#### Push the local branch
-
-```shell
-NEW_DEVTOOLS_VERSION=2.7.0 # Change this to the new version
-```
-
-```shell
-git add . && \
-git commit -m "Prepare for $NEW_DEVTOOLS_VERSION release." && \
-git push origin release_$NEW_DEVTOOLS_VERSION;
-```
-
-From the git GUI tool or from github.com directly:
-1. Create a PR.
-2. Add the entry about the created PR to the CHANGELOG.md manually, and push to the PR.
-3. Receive an LGTM, squash and commit.
-
-### Test the release
-
-- Checkout the commit you just created,
-   - or remain on the branch you just landed the prep PR from.
-   ```shell
-   git checkout 8881a7caa9067471008a8e00750b161f53cdb843
-   ```
+### Test the CLEAN_BRANCH 
+> You only need to do this on the $DEVTOOLS_CLEAN_BRANCH branch
 
+- Checkout the $DEVTOOLS_CLEAN_BRANCH,
 - Build the DevTools binary and run it from your local Dart SDK.
    - From the main devtools/ directory.
    ```shell
@@ -137,6 +80,19 @@ From the git GUI tool or from github.com directly:
       git checkout . && \
       git clean -f -d;
       ```
+#### Push the DEVTOOLS_CLEAN_BRANCH
+
+> Ensure you are still on the $DEVTOOLS_CLEAN_BRANCH
+
+```shell
+git push -u origin $DEVTOOLS_CLEAN_BRANCH
+```
+
+From the git GUI tool or from github.com directly:
+1. Create a PR.
+2. Add the entry about the created PR to the CHANGELOG.md manually, and push to the PR.
+3. Receive an LGTM, squash and commit.
+
 
 ### Tag the release
 - Checkout the commit from which you want to release DevTools
@@ -150,6 +106,21 @@ From the git GUI tool or from github.com directly:
    tool/tag_version.sh;
    ```
 
+### Verify and Submit the release notes
+
+See the release notes
+[README.md](https://github.com/flutter/devtools/blob/master/packages/devtools_app/lib/src/framework/release_notes/README.md)
+for details on where to add DevTools release notes to Flutter website and how to test them.
+
+1. The release notes for the clean version can be found in [NEXT_RELEASE_NOTES.md](./release_notes/NEXT_RELEASE_NOTES.md)
+2. Follow the release notes
+[README.md](https://github.com/flutter/devtools/blob/master/packages/devtools_app/lib/src/framework/release_notes/README.md)
+to add these DevTools release notes to Flutter website
+   - make sure to also follow the instructions to test them.
+
+
+[1]: ../packages/devtools_app/lib/src/framework/release_notes/release-notes-next.md
+
 ### Upload the DevTools binary to CIPD
 - Use the update.sh script to build and upload the DevTools binary to CIPD:
    ```shell
@@ -213,19 +184,12 @@ From the git GUI tool or from github.com directly:
    flutter pub publish
    ```
 
-### Write release notes for the release
-Release notes should contain details about the user-facing changes included in the release.
-
-These notes are shown directly in DevTools when a user opens a new version of DevTools.
-
-1. Request the team to verify their important user facing changes are documented in
-   [release-notes-next.md][1].
-
-2. See the release notes
-[README.md](https://github.com/flutter/devtools/blob/master/packages/devtools_app/lib/src/framework/release_notes/README.md)
-for details on where to add DevTools release notes to Flutter website and how to test them.
-
-3. Copy the content of [release-notes-template.md](../packages/devtools_app/lib/src/framework/release_notes/release-notes-template.md) to [release-notes-next.md][1], to contain
-   draft for the next release.
+### Push the DEVTOOLS_NEXT_BRANCH
+```shell
+git checkout $DEVTOOLS_NEXT_BRANCH
+git push -u origin $DEVTOOLS_NEXT_BRANCH
+```
 
-[1]: ../packages/devtools_app/lib/src/framework/release_notes/release-notes-next.md
+From the git GUI tool or from github.com directly:
+1. Create a PR.
+3. Receive an LGTM, squash and commit.

tool/release_helper.sh

@@ -1,20 +1,20 @@
-#!/bin/bash -e
+#!/bin/bash -ex
 
 DEVTOOLS_REMOTE=$(git remote -v | grep "flutter/devtools.git" | grep "(fetch)"| tail -n1 | cut -w -f1)
 TYPE=$1
 
-if [ -z ${TYPE+x} ] ; then
+if [ -z "$TYPE" ] ; then
     echo "$0 expects a type as a first parameter"
     exit 1
 fi
 
-if [ -z ${DEVTOOLS_REMOTE+x} ] ; then
+if [ -z "$DEVTOOLS_REMOTE" } ] ; then
     echo "Couldn't find a remote that points to flutter/devtools.git"
     exit 1
 fi
 
 STATUS=$(git status -s)
-if [[ -z  ${STATUS+x} ]] ; then
+if [[ ! -z  "$STATUS" ]] ; then
     echo "Make sure your working directory is clean before running the helper"
     exit 1
 fi