Release Process Notes [notes for main collaborators who need to perform a release]

• 🎶 These notes can be ignored by almost all contributors. They are for main collaborators who need to perform a release 🎶

[2023 Feb]

1. In the PR to release, prepare for deploy to npm:

• npm run bump this bumps the package.json AND package-lock.json to the next version
• add entry to CHANGELOG.md for that version
• commit and push

2. Via github, merge the PR to master

• github action will then build master and run tests

If OK, then continue.

3. Use local test harness to get latest version:

cd example/library-usage-via-TypeScript

./build.sh

Note on build.sh: This installs the latest version of ts-unused-exports, and builds the example.

Test it:

./execute.sh

Take a copy of the package-json file:

cp node_modules/ts-unused-exports/package.json ./tsu-pj.json

4. Use the github action to deploy to npm

5. Use local test harness to check the package-lock.json only contains intended changes:

cd example/library-usage-via-TypeScript
npm i ts-unused-exports@latest

Test it:

./execute.sh

Compare the package-json file to the copy made earlier:

diff ./tsu-pj.json  node_modules/ts-unused-exports/package.json

The differences should normally only be the version number (and the _resolved, _integrity and _from fields).

If all is OK, then you have successfully released 🎈.

Finally, don't forget to say 🙏 to the contributors who helped with the PR 🥳 .