Creating a Release of the SAF CLI

NOTE: If there aren't any Dependency Updates when viewing the draft release, check the Actions and ensure that all dependabot actions have executed successfully.

We are currently automating the release process. Steps 1 through 5 are now automated by invoking the release-prep.sh script located at the root of the repository

1. Make sure you're on the most recent commit on the SAF CLI by running git pull.
2. Bump the SAF CLI version number in the VERSION file and package.json
   • It is a good idea to manually check and update the version of any @mitre dependencies in the package.json file.
3. Run npm install
4. Validate the build and unit tests
   • Run npm pack
     • Does a fresh build, checks for type issues, etc.
   • Run npm run test
5. Add these changes, commit this change, associate a version tag with the commit (for example, "1.0.0"), and push them up
   • git add the relevant files (Do not add the .tgz file that may have been created by the npm run prepack step)
   • git commit -sm "[version]"
   • git tag -am "brief description of change" [version]
   • git push --atomic origin main [version]
6. Github actions will fire to produce executable versions of the SAF CLI for several OSes. Wait for the workflows for the macOS builds (.pkg), Windows builds (.exe), Apt-based build (.deb) and Dnf-based builds (.rpm) to finish. Download, and unzip the artifacts:

• Mac OS (zip file containing the following)
  • saf-v[version]-x64.pkg
  • saf-v[version]-arm64.pkg
• Windows (individual downloads - not zipped)
  • saf-v[version]-x64.exe
  • saf-v[version]-x86.exe
• Apt-based distros like Debian (zip file containing the following)
  • saf-v[version]-amd64.deb
  • saf-v[version]-arm64.deb
  • saf-v[version]-armel.deb
• Dnf-based distros like RHEL (single file)
  • saf-v[version]-noarch.rpm

7. Associate the tags with the drafted release (Combine all updates, except for "## Dependency Updates", under a "## What's New" section in the description)
8. Attach the aforementioned, renamed artifacts to the draft release (Note: Attaching files using the drag and drop feature is much slower than attaching files by clicking on the link directly to upload files)
9. Make sure that the Set as the latest release checkbox is selected
10. Publish release
11. Wait for push-to-npm on release to complete
12. Update the SAF Github Action Dependency by creating a release:
    • Follow SAF Action Release instructions
13. Validate that the Homebrew Formula at https://github.com/mitre/homebrew-saf was automatically updated