Skip to content

MAINTAINING.md

Latest commit

 

History

History
38 lines (32 loc) · 1.23 KB

MAINTAINING.md

File metadata and controls

38 lines (32 loc) · 1.23 KB

Deployment Checklist

  • git checkout master && git pull upstream master
  • npm config get registry
    • Make sure it's https://registry.npmjs.org/
  • npm run clean
  • optionally: npm run nuke && npm run bootstrap
  • lerna run prepublish
  • npm test
  • export GITHUB_AUTH="..."
  • npm run changelog >> CHANGELOG.md
  • Edit CHANGELOG.md:
    • Move new entry to top
    • Put correct version in place of Unreleased
    • Remove private packages from headings
  • git add CHANGELOG.md
  • lerna publish
    • If there are changes to READMEs, see Publishing with README changes
  • Edit release tag on GitHub and paste the changelog entry in.

Publishing with README changes

Lerna can't update READMEs on npmjs.com. If we have a README change that we want to show up there, then we need to publish by hand. We can still let Lerna do most of the setup work for us, though:

  • lerna publish --skip-npm
  • For each package: npm publish packages/<package>

Updating annotated source code

  • git checkout gh-pages
  • git rebase master
  • npm run docs
  • git add annotated-src
  • git commit --amend
  • git push -f upstream gh-pages