Skip to content
This repository has been archived by the owner on Jun 23, 2019. It is now read-only.

Latest commit

 

History

History
78 lines (54 loc) · 3.09 KB

RELEASE.md

File metadata and controls

78 lines (54 loc) · 3.09 KB
Raw

Releasing a New Version

This document describes how to release a new version of Apiary Blueprint Parser.

  1. Make sure that tests are green

    Before the release, the tests need to pass both in Node.js and in supported browsers. See test/README for detailed instructions how to run them.

  2. Update CHANGELOG

    Go through all commits since the last release and mention changes that affect users or big internal changes in CHANGELOG. Small internal changes or bugfixes can be grouped under item like "Various code improvements and fixes". Use your best judgment to decide into which category each change belongs to. Formatting of the new entry should follow the style used in previous entries.

    Commit the change in a commit with message "Update CHANGELOG". Do not push this commit yet.

  3. Update version

    Look at VERSION for the current version. Grep for it in the code and replace all relevant occurrences (which are usually all occurrences beyond the one in CHANGELOG) with the new version.

    What the new version should be is determined by the set of changes since the last release. The parser uses semantic versioning.

    Commit the change in a commit with message "Update version to ", where <version> is the new version. Do not push this commit yet.

  4. Publish a npm package

    Run npm publish . in the parser root directory. This will create a new version of the npm package and publish it.

  5. Test the published npm package

    Create a testing project somewhere on the side, install the just released npm package into it and make sure it works. Requiring the parser and trying it on some simple input is enough.

    If the parser doesn't work, find the cause, fix it in one or more commits and then republish the npm package. Repeat this until the parser works.

  6. Publish a browser build

    Create a browser build by running make dist. Rename the resulting file (found in the dist directory) to include version (apiary-blueprint-parser-<version>.js, where <version> is the released version).

    Publish the browser build to Amazon S3 using the tools/upload-browser-build/upload-browser-build script. If you are doing this on a fresh checkout, you will need to rename the tools/upload-browser-build/config.yml.example file to tools/upload-browser-build/config.yml and fill-in your credentials.

  7. Tag the release

    Tag the release by running git tag v<version>, where <version> is the released version. Push the accumulated commits from previous steps together with the tag by running git push --tags. Verify that everything was pushed correctly on the GitHub website.

  8. Announce the release

    Announce the release to the Google Group. Use previous release announcements as a template.

  9. Done!

    You are done now! Stretch and relax a bit :-)