Table of Contents

Prerequisites

Set up your NPM permissions by following the steps here: ARCHIVE: How do I publish an edX npm package?

Update the toolkit version in the code:

Create a new branch from master

git checkout master
git pull
git checkout -b USERNAME/release-MM-DD-YYYY

Update the version number:
- We use semantic versioning.
- Update bower.json (for the Bower package)
- Update package.json (for the NPM package)
Add release notes to CHANGELOG.md
- Determine all the changes since the subsequent release
- e.g. Look at the commits here: https://github.com/edx/edx-ui-toolkit/commits/master
- Add a new section to CHANGELOG for the release number with bullets for each important change
Add and commit all the updated files
- Use the commit message "Release <major.minor.patch>"
  - ```
  e.g. "Release 0.10.0"
```
Create a PR with your changes
- Note: you only need one reviewer for a release PR
Merge your changes once you have thumbs

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

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

Publish the updated version to NPM

git checkout master
git pull
npm publish

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