Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.27 KB

DEV.md

File metadata and controls

26 lines (17 loc) · 1.27 KB
Raw

Some developer guidelines

Merge strategies

  • Feature branches to dev: squash commit
  • Continuous Release from dev to main: standard merge commit
  • Hotfixes: branch off main, merge PR into main via squash commit, then merge back main to dev via standard merge commit.

Create a new release (and publish to npm)

As this is only a small project, we haven't automated publishing to the NPM registry yet and instead rely on the following manual workflow.

  • Make sure the tests pass locally: npm test ✔
  • Make another commit on the dev branch bumping the npm version in the package.json. For that, use:
npm run bump-version -- [<newversion> | major | minor | patch]
  • ⚠ Copy the version specifier from package.json into the index.js meta information object.
  • Once the dev branch is ready, open a PR (Pull request) called "Continuous Release <version.number>" and give it the "release" label. Merge this PR into main.
  • Create a new release via the GitHub UI and assign a new tag alongside that.
  • Fetch the tag locally (git fetch) and publish to npm via npm run publish-final. You probably have to login to npm first (npm login).
  • Enjoy ✌ Check that the release is available here on npm.