$customHeader
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

« Previous Version 2 Next »

A guide to publishing a package to NPM using Travis. 


This is a Work in Progress - modifying the pypi docs for NPM


Step-by-step guide

  1. If you're not familiar with how to package a JS module and and share it on NPM, get your bearings by reading their docs.
  2. Modify your repo's Travis configuration so that tagging a release results in a publish to npmjs.

    1. Contact DevOps to get publish tokens for the edX NPMJS account. Use the Travis CI command line client to encrypt the token: 

      travis encrypt --add deploy.api_key NPMTOKEN
    2. There are two options here, using the Stages feature of Travis (studio-frontend) or using Travis' simple built-in deploy
    3. Travis documentation on NPM deployment
  3. To publish a new version of your package, update the version, then push a corresponding tag to GitHub.
  4. You're done! Don't forget to update webpack files so they download the new package from NPM.


Find your package at https://pypi.python.org/pypi/[package-name]/[version]

Troubleshooting

If your tag is in GitHub, but is not starting a build in Travis, or if you are deploying from too many sub-builds in Travis, see the following changes to .travis.yml.

  • No labels
$customFooter