Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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"
  3. Confirm your settings: 

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

Update the version

Update the Pattern Library version in the code:

  1. Create a new branch from master 

    git checkout master
    git pull
    git checkout -b USERNAME/library-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
  4. Build the minified and uglified production assets:

    gulp build-production
  5. Add and commit all the updated files

  6. Create a PR with your changes using the Pattern Library PR Template.
    • Note: you only need one reviewer for a release PR
  7. 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:

  • No labels