CI: Workflow to Publish to npm if Package Version is Changed

[BowTiedDevOps]

Description

As per https://github.com/stacks-network/stacks-test-tools/issues/6, a workflow that automatically pushes packages to npm when it detects a version changed is a good addition, because some developers that update these packages might not have the permissions to publish themselves, and it makes their jobs easier by not having to worry about uploading the package once it's updated - that is now automated.

Closes #6

Notes:

• Prior to using this workflow, a repository secret named NODE_AUTH_TOKEN must be added, and it should contain the npm auth token of the stacks organisation (Automation type, so it can bypass 2FA).
• The current workflow ONLY works with node packages. The workflow will have to be updated prior to any other type of package addition because otherwise it will fail every time a commit is made to that crate.
• The workflow currently uses the --access=public option for npm publish command because I couldn't test it with private packages. This will need a discussion with Jesse so I can properly update the command.

Workflow runs:

• Change package, not version (0 published to npm currently): https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554751746
• Update version (failure due to package name - left it @stacks/clarunit): https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554791139
• Update version (failure due to package visibility): https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554829713
• Update version (1st publish to npm): https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554873112
• Update package, not version: https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554905445
• Update package and version: https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554915725
• Add 2nd package (2nd publish to npm): https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554946407
• Update version of 2nd package: https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554965295
• Update 2nd package, not version: https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554979305
• Add 3rd package (3rd publish to npm): https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8554994122
• Change code in none of the packages: https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8555017431
• First commit to the source commit branch of this PR (added job names so it shows them instead of the ids): https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8555076098

NPM Profile (Published Packages): https://www.npmjs.com/~bowtieddevops

Tag @wileyj and @hugocaillard because I can't add reviewers on this repo.

[wileyj]

fyi i've added the npm auth token to this repo

[BowTiedDevOps]

@hugocaillard @MarvinJanssen After talking to Jesse, we've come to a solution regarding the access option - we will keep it public (if anyone wants to publish a private package, this ain't the place) and I'll change to an action that makes parsing the args to npm publish easier. I do have 1 question regarding the solo npm ci step though (silly me thought it comes from Continuous Integration) - it's useless rn, I can either remove it or do a npm ci && npm test command which will look like this:

- name: Test Package
  id: test_package
  run: |
    cd ${{ needs.check_version_change.outputs.PACKAGE_PATH }}
    npm ci
    npm test

Question is - do we want to test before publish or not?

[hugocaillard]

Yes npm ci is a bit badly named i think Yes I think it's better to run the tests before publishing 👍

[BowTiedDevOps]

Run with npm test and publish after latest commit: https://github.com/BowTiedDevOps/stacks-test-tools/actions/runs/8570853362/job/23489745755