semantic-template

Purpose

• Automate semantic versioning of a package, via semantic-release.
  • This bumps the semantic version of the package in package.json, as well as applying a git tag to each release.
• Automate publishing of releases to the npm registry.

Each commit merged or pushed to master will trigger a new release.

The current semantic version of the package will be determined via its commit messages, using the conventional commits specification.

The latest version of the package will then be published to the npm registry.

The above is automated via GitHub Actions.

Use

1. Clone template:

git clone https://github.com/rom-dos/semantic-template [optional new repo name]

2. Adjust package "name" property in package.json (and other relevant fields, such as "repository", etc).

3. Add new repo on GitHub.

4. Add personal NPM_TOKEN as a repository secret:

See Adding secrets for a repository and Creating and viewing access tokens.

5. git commit && git push code to GitHub, using conventional commits.