UI Toolkit release process

Table of Contents

Prerequisites

Become an NPM contributor

1. Create a new NPM user at https://www.npmjs.com.

2. Set up your NPM author information (taken from https://gist.github.com/coolaj86/1318304): 

   npm set init.author.name "Your Name"
   npm set init.author.email "you@edx.org"
   npm adduser  # enter your npm username and password

3. Confirm your settings: 

   npm config ls

4. Create an IT ticket to request that your account be made a contributor

• • Include your NPM account name and a link to the library (https://www.npmjs.com/package/edx-ui-toolkit)

  • Add Andy Armstrong (Deactivated) to the ticket

Update the version

Update the toolkit version in the code:

1. Create a new branch from master 

   git checkout master
   git pull
   git checkout -b USERNAME/toolkit-release

2. Update the version number:
   • Update bower.json (for the Bower package)
   • Update package.json (for the NPM package)
3. Add release notes to CHANGELOG.md
   • Determine all the changes since the subsequent release
   • e.g. https://github.com/edx/edx-ui-toolkit/compare/0.10.0...master
   • Add a new section to CHANGELOG for the release number with bullets for each important change

4. Add and commit all the updated files

5. Create a PR with your changes
   • Note: you only need one reviewer for a release PR

6. Merge your changes once you have thumbs

Publish Package to Bower & NPM

The UI Toolkit is available as both bower and NPM packages.  Please follow these instructions for publishing to both package managers.

1. Create a new release in GitHub
   • For example:
     
   • Include the same bullet points from the CHANGELOG
   • Note that Bower will automatically create a new release once the GitHub release has been created

2. Publish the updated version to NPM

   npm publish

3. Confirm that the version updates have been applied:

   • Look at the top of this page: https://www.npmjs.com/package/edx-ui-toolkit

   • Note that there may be a slight delay before the updated versions appear