Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.54 KB

release.md

File metadata and controls

37 lines (22 loc) · 1.54 KB

Webdriver Manager Release Checklist

Say the previous release was 0.0.J, the current release is 0.0.K, and the next release will be 0.0.L.

  • Make sure Travis is passing.

  • Make sure .gitignore and .npmignore are updated with any new files that need to be ignored.

  • 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.

  • Update CHANGELOG.md

    • You can get a list of changes in the correct format by running
    git log 0.0.J..HEAD --format="- ([%h](https://github.com/angular/webdriver-manager/commit/%H)) %n%w(100,2,2)%B" > /tmp/changes.txt
    
    • Create a new section in CHANGELOG.md and copy in features (feat), big dependency version updates (deps), bug fixes (fix), 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.

    • Breaking changes should be in their own section and include before/after examples of how to fix code that needs to change.

  • Make a commit with the API and package.json changes titled chore(release): version bump and changelog for 0.0.K.

  • Tag the release with git tag 0.0.K

  • Push to github

  • Push tags to github (git push <remote> --tags)

  • Verify that the changelog and tags look sane on github

  • NPM publish

  • Let people know

    • Have @ProtractorTest tweet about it
  • Close the 0.0.K milestone