Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.4 KB

RELEASE.md

File metadata and controls

25 lines (19 loc) · 1.4 KB

Releasing

Libraries

Prepare

This can be done from develop or seperate release branches (before merging to develop)

  1. Change the version-number in accordance with the magnitude of change.
    1. If its not a @latest release, the type should be "dashed", for example; 0.0.0-beta or 0.0.0-dev.20210101.
    2. We try to follow semver but are holding back major v1 until we feel its ready.
  2. Update the changelog for your library in CHANGELOG.md.
    1. Follow the guide in the changelog file.
  3. Add a release on github with the changes you added in CHANGELOG.md.
    1. Name the release in accordance with package name and version, for example; [email protected]

Publish

  1. Find the corresponding workflow for your library, usually prepended with "Publish <LIBRARY NAME>".
  2. "Run workflow" and decide if input values need to be changed.
    1. Storybok slot: If present, choose which environment Storybook should be updated.
      1. Leave this input empty for deployment to production
    2. NPM tag: Choose which tag to apply to the published package
      1. Choose latest for production release
  3. ⚠️ Check "Publish eds-<LIBRARY NAME> to npm" step to verify the package was actually published. If an existing version exists on npmjs.org, the package will not be published, but this step will still pass.