Skip to content

Commit

Permalink
Update release.md to freeze master (#726)
Browse files Browse the repository at this point in the history
* Update release.md
  • Loading branch information
jeremyliweishih authored Apr 27, 2020
1 parent dda174f commit 747df6a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Changelog
* Fixes
* Changes
* Documentation Changes
* Add instructions to freeze `master` on `release.md` :pr:`726`
* Testing Changes


Expand Down
2 changes: 2 additions & 0 deletions release.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Before starting the release process, verify the following:
* The [Read the Docs build](https://readthedocs.com/projects/feature-labs-inc-evalml/builds/) for "latest" is marked as passed.
* The [public documentation for the "latest" branch](https://evalml.featurelabs.com/en/latest/) looks correct, and the [changelog](https://evalml.featurelabs.com/en/latest/changelog.html) includes the last change which was made on master.
* The [performance tests](https://github.com/FeatureLabs/evalml-performance-tests) have passed on latest master, and the team has reviewed the results.
* Communicate to the team that `master` is frozen until release PR is merged

## 1. Create release PR to update version and changelog
A release PR should have the version number as the title (i.e. "vX.X.X") and the changelog updates as the PR body text. The PR should be based off master.
Expand All @@ -19,6 +20,7 @@ Make the following changes in the release PR:
* Move changelog items from `Future Releases` into the correct version number.
* Confirm that all release items are in the changelog under the correct header, and that no extra items are listed.


An example can be found here: https://github.com/FeatureLabs/evalml/pull/163

**Note**: get the PR reviewed and approved before merging. Also, verify again that all tests are currently green on master, that all checkin tests are passing, that the Read the Docs build for the release PR branch has passed and that the resulting docs contain the expected changelog. After merging, verify Read the Docs "latest" is correct.
Expand Down

0 comments on commit 747df6a

Please sign in to comment.