Nestjs Package Template

A starter template code for publishing reusable small independent nestjs modules for nestjs applications.

Usage

• Create a new repository using this template repository
• Run npm i
• Update the file names and code inside /src as you need.

Semantic Release

We use semantic release to publish packages to npm registry.
.github/workflows/release.yml contains the basic release steps.

(Important) Setup semantic release using the following command:
npx semantic-release-cli setup

Details: https://github.com/semantic-release/semantic-release/blob/master/docs/usage/getting-started.md#getting-started

Commitizen

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.

Guidelines: Angular JS's commit message convention

Install commitizen cli globally:
npm install commitizen -g

Push

When you are done with all the changes, kindly commit with the following rules:

Commits

Kindly use commitizen cli. Once you install the commitizen cli globally, you can run git cz to easily enter the type, scope, and related details of current changes.

git add changed-file.js
git cz
// allow commitizen cli to guide you with commit message

Push

npm run push origin master

Publishing to NPM registry

If you have configured semantic-release and used commitizen, then a new release should be published to Github and NPM registry.