template-node-package

This is my template node package. I am seeing if github actions can deploy this automatically for me.

Setup instructions

• Rename variables in package.json:
  • name
  • description
  • repository.url
  • bugs.url
  • homepage
• Install packages using npm i
• Enable GitHub Actions permissions on GitHub to create or approve pull requests (Settings -> Actions -> General -> Workflow permissions -> Allow GitHub Actions to create and approve pull requests).
• Create an access token (automation type) on npmjs.com, and add it as a secret on your github secrets as NPM_TOKEN (Settings -> Secrets and variables -> Actions -> Secrets -> New repository secret).
• Delete CHANGELOG.md so it can be created with info about the new package.
• Create new release note by running npm run add:release-note. Select patch when option appears.
• Commit and push changes.
• After github actions run, merge in created pull request.

Commands

• build: Converts the typescript code to javascript.
• add:release-note: Adds a release note for the changes you have made. For minor and major releases, make sure they are their own commit.
• publish-package: Used by the actions to publish the package to npm.
• clear-dist: Removes the dist folder.
• lint: Checks the linting of the typesript folders.
• test: A test command, add a test command in here.