sartography
/
bpmn-js-spiffworkflow
mirror of https://github.com/sartography/bpmn-js-spiffworkflow.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documenting the release process

This commit is contained in:
Dan 2022-06-09 13:18:49 -04:00
parent f8bf463a8a
commit e18bb22f6f
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
RELEASE_PROCESS.md
View File

@ -1,11 +1,15 @@
## Releases
Be sure to edit the package.json, and update the version. Releases won't create
a new NPM package unless the version was updated. Be sure to create a new version
that matches
And also edit setup.py and assure that has the same release tag.
New versions of SpiffWorkflow are automatically published to PyPi whenever
a maintainer of our GitHub repository creates a new release on GitHub. This
is managed through GitHub's actions. The configuration of which can be
found in .github/workflows/....
Just create a release in GitHub that mathches the release number in doc/conf.py
a new NPM package unless the version was updated.
A good way to do go about this is with npm version. Which will increment the version in package.json and create a new commit and tag. Here are few examples that you might use, but
there is more information on [NPM Version](https://docs.npmjs.com/cli/v8/commands/npm-version).
For doing a patch release, you can do
```bash
npm version patch -m "Upgrade to %s for reasons"
```
aside from patch, you can use the keywords `minor`, and `major` (there are some others).
Once this is complete, log into GitHub and do an offical release of the package. A published release will result in a new published version on NPM (via a GitHub Action)