Skip to content

release-process.md

Latest commit

 

History

History
68 lines (37 loc) · 2.99 KB

release-process.md

File metadata and controls

68 lines (37 loc) · 2.99 KB

PowerTip release process

THIS DOCUMENT IS FOR INTERNAL REFERENCE ONLY - I am documenting the release process so that I have a nice checklist to go over when releasing a new version of PowerTip. You probably don't care how PowerTip is built and released unless you plan on maintaining your own fork.

Version format

PowerTip uses Semantic Versioning and the version is in the format of [MAJOR].[MINOR].[PATCH]. Versioning is dictated by the exposed API that PowerTip users consume when using the plugin.

This includes anything in the following namespaces:

  • $.fn.powerTip
  • $.fn.powerTip.defaults
  • $.fn.powerTip.smartPlacementLists
  • $.powerTip

The events that fire during the tooltip life cycle are also considered to be part of the API for versioning purposes.

Semantic versioning requirements

  • MAJOR version when you make incompatible API changes,
  • MINOR version when you add functionality in a backwards-compatible manner, and
  • PATCH version when you make backwards-compatible bug fixes.

The release process

  1. Update the date and diff for the release in CHANGELOG.yml

    The CHANGELOG.yml file is used to generate the release notes seen on the project page.

  2. Bump the version in package.json

    The package.json is used when building the project and when publishing to npm.

  3. Run grunt build:release

    This will build and test all of the code and generate the zip archive for release in the dist folder.

  4. Tag the version

    Make sure the changes from steps 1 and 2 have been committed.

    git tag -a vX.X.X -m "version X.X.X"

  5. Run grunt deploy

    This will build the project page content, commit it to the gh-pages branch, and return to the master branch. It does not push any changes to the repo.

  6. Review commits and push them

    POINT OF NO RETURN

    This is the fail-safe step. Make sure the build looks right. Make sure the commits from steps 1 and 2 are correct. Make sure the commits added to the gh-pages branch look right. If everything looks good then push the commits and the tag.

  7. Publish to npm

    Prefer npm version 4.0.0 or greater for prepublishOnly script

    First, verify that the package to be release to npm contains the expected files in the expected structure. Run grunt build:npm && npm pack. This will generate the appropriate dist folder contents and create the tgz package. Look over the tgz package to make sure everything looks good.

    Now publish the new release to the npm repository by running the npm publish command.

  8. Add new release to GitHub repo

    Add a release for the tag you just created, copy and paste the release notes, and add the zip archive to the release.

  9. Update JSFiddle if needed (it usually will not be needed)

    The PowerTip JSFiddle is used by people wanting to quickly play with the plugin before really digging into it. If there were any breaking changes or significant new features then they should be added to the JSFiddle.