Skip to content
This repository was archived by the owner on Jul 29, 2024. It is now read-only.

Commit a8f4cd9

Browse files
committed
chore(release): add first version of release checklist
1 parent 981c611 commit a8f4cd9

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

Diff for: release.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
Protractor Release Checklist
2+
----------------------------
3+
4+
Say the previous release was 0.0.J, the current release is 0.0.K, and the next release will be 0.0.L.
5+
6+
- Check that features and bug fixes are in by looking at the milestone tag for 0.0.K. Create a milestone for 0.0.L, and bump anything that doesn't need to be finished from 0.0.K to 0.0.L.
7+
8+
- Check if there are new versions of selenium, chromedriver, or latest browsers that the configuration needs to be updated against.
9+
10+
- Make sure [Travis](https://travis-ci.org/angular/protractor/builds) is passing
11+
12+
- Make sure `npm test` is passing (this runs more that just what is run on Travis)
13+
14+
- Make sure .gitignore and .npmignore are updated with any new files that need to be ignored.
15+
16+
- Generate new API documentation. Run `scripts/generate-docs.js`
17+
18+
- Update package.json with a version bump. If the changes are only bug fixes, increment the patch (e.g. 0.0.5 -> 0.0.6), otherwise increment the minor version.
19+
20+
- Update CHANGELOG.md.
21+
- You can get a list of changes in the correct format by running
22+
```
23+
git log 0.0.J..HEAD --format="- ([%h](https://github.com/angular/protractor/commit/%H)) %n%w(100,2,2)%B" > /tmp/changes.txt
24+
```
25+
26+
- Create a new section in CHANGELOG.md and copy in features, bug fixes, and breaking changes. No need to note chores or stylistic changes - the changelog should be primarily useful to someone using Protractor, not developing on it.
27+
28+
- Breaking changes should be in their own section and include before/after examples of how to fix code that needs to change.
29+
30+
- Make a commit with the API and package.json changes titled chore(release): version bump and changelog for 0.0.K.
31+
32+
- Tag the release with `git tag 0.0.K`
33+
34+
- Push to github
35+
36+
- Push tags to github (`git push upstream --tags`)
37+
38+
- Verify that the changelog and tags look sane on github
39+
40+
- NPM publish
41+
42+
- Let people know
43+
- Have @ProtractorTest tweet about it
44+
45+
- Close the 0.0.K milestone

0 commit comments

Comments
 (0)