Skip to content

Latest commit

 

History

History
56 lines (42 loc) · 2.23 KB

PUBLISHING.md

File metadata and controls

56 lines (42 loc) · 2.23 KB

PUBLISHING

A reference guide on how to do releases of the VF monorepo's tools and components.

Notes

Release workflow

1. Component pre-release

  1. select the develop branch
  2. see a list of changed packages
    • lerna changed
  3. test publish
    • yarn run lerna:test

2. Component release

  1. publish to npm
    • yarn run lerna:publish

3. Communications

  1. update the expected new tag version to /tools/vf-component-library/src/site/_data/siteConfig.js
    • see last tag git describe --abbrev=0 --tags
  2. generate an update
    • yarn run releasenotes
    • format and review the newly made file at tools/vf-component-library/src/site/updates

4. Post-release

  1. commit and push changes to the develop branch
    • commit message in a format of: Component release 20200330-01
  2. add a tag"
    • see last tag git describe --abbrev=0 --tags
    • add a semantic versioned tag git tag -a v2.4.10 -m 'Release of precompiled CSS, JS, assets'
    • Why like this?
      • We do not add tags per individual component version, Lerna needs a named tag to see what has changed. This way we get one tag per release "bundle" avoiding tag spamming in the release history.
      • Trigger a deploy to the CDN (i.e. v2.4.5-rc.1) https://assets.emblstatic.net/vf/v2.4.10/css/styles.css
  3. push the tag
    • git push origin --tags
  4. add release notes to the tag and link to the new blog post

Appendix of useful Lerna commands

  • lerna ls list all packages known to lerna
  • lerna ls --since af04cb2a list all changed packages since a commit (sadly not combinable with lerna publish)
  • lerna diff all changes since last publish
  • lerna changed all packages changed