From 1d8a3fe8768a51f229be63ff8427bc96be8d294c Mon Sep 17 00:00:00 2001 From: mitch Date: Thu, 7 Jul 2022 15:53:45 -0500 Subject: [PATCH] add release notes to a wiki --- wiki/A2J Deps Release.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 wiki/A2J Deps Release.md diff --git a/wiki/A2J Deps Release.md b/wiki/A2J Deps Release.md new file mode 100644 index 0000000..74da29f --- /dev/null +++ b/wiki/A2J Deps Release.md @@ -0,0 +1,8 @@ +## A2J Deps Release: +- Change to the `develop` branch if not already on it. +- Do a `git pull` to make sure you are up to date with all changes. +- Make sure you are logged into `npm`. In your terminal type `npm whoami` and be sure you have permissions to do npm releases with that account for this repo. +- Run `npm run release:` where `` could be either `patch`, `minor`, or `major`. Example, for a bug fix that is not a breaking change, you would run `npm run release:patch`. +- This will execute the release script, running the tests first (a release will not happen with failed tests) +- Once the npm release is successful, do a pull request from `develop` into `production` to keep it in parity with the npm release. +- OPTIONAL -> Update Author, Viewer and/or A2J DAT to this new release as needed. aka `npm install @caliorg/a2jdeps@latest` which will update both the package.json file and the package-lock.json to this latest release version in the respective codebase. \ No newline at end of file