Skip to content

DEV-README.md

Latest commit

 

History

History
119 lines (86 loc) · 4.78 KB

DEV-README.md

File metadata and controls

119 lines (86 loc) · 4.78 KB

TS Guards

Description

Typescript guards library.

Yarn version

v4.9.0

npm install -g corepack@0.31.0
corepack enable
yarn install

Node version

v20.9.0. Use NVM:

  1. nvm current - check current version of Node
  2. nvm list - show list of available Node versions
  3. nvm install - to install and use Node version.
  4. nvm use - set version of Node as current version

Available Scripts

In the project directory, you can run:

yarn version:major

Increments the major version in package.json and src/app/manifest.json.
For example, changes "version": "1.2.3" to "version": "2.0.0".

yarn version:minor

Increments the minor version in package.json and src/app/manifest.json.
For example, changes "version": "1.2.3" to "version": "1.3.0".

yarn version:patch

Increments the patch version in package.json and src/app/manifest.json.
For example, changes "version": "1.2.3" to "version": "1.2.4".

yarn update-version:major

Automates the process of merging branches, increasing the major-version in the package.json file, and committing the changes to the designated branch. This ensures the version is updated consistently and the changes are easily trackable in the repository.

yarn update-version:minor

Automates the process of merging branches, increasing the minor-version in the package.json file, and committing the changes to the designated branch. This ensures the version is updated consistently and the changes are easily trackable in the repository.

yarn update-version:patch

Automates the process of merging branches, increasing the patch-version in the package.json file, and committing the changes to the designated branch. This ensures the version is updated consistently and the changes are easily trackable in the repository.

yarn build

First removes the dist directory using rimraf to ensure a clean build environment and then compiles the TypeScript files using tsc.

yarn publish-package

Publishes the package with public access.

yarn format

Formats all TypeScript files using Prettier.

yarn lint

Runs ESLint for static code analysis on TypeScript files.

yarn lint:fix

Fixes errors found by ESLint in TypeScript files.

yarn test:unit

Runs unit tests using the Jest configuration.

yarn test:unit-cov

Runs unit tests with coverage calculation option.

yarn test:unit-watch

Runs unit tests with watch mode.

yarn docs

Generates comprehensive documentation using TypeDoc.

📦 How to set up automatic publishing to npm

To enable automatic publishing of the package when changes are pushed to the main branch, follow these steps:

1. 🔐 Generate an Automation Token on npm

  1. Open your NPM package on https://npmjs.com -> Access Tokens
  2. Click "Generate New Token" -> "Classic Token", then choose Type - Automation
  3. Copy the generated token (you won’t be able to see it again!).

📘 See npm’s official docs for more info.

2. 🔑 Add the Token to GitHub Secrets

  1. Open your GitHub repository.
  2. Go to Settings → Secrets and variables → Actions.
  3. Click "New repository secret".
  4. Name it: NPM_TOKEN
  5. Paste the token value.

📘 See GitHub’s guide on encrypted secrets for details.

3. ✅ That’s it!

The GitHub Actions workflow will now use NPM_TOKEN to publish the package when version changes are pushed to main.

⚠️ Make sure to bump the version in package.json before pushing — otherwise, the workflow will fail due to version conflict.

Release steps

  1. run yarn update-version:patch (or :minor, :major)

  2. create PR with message "[Common] Version increase vX.X.X" from "common/version-increase" into "develop"

  3. create PR with message "Release vX.X.X" from "develop" into "main"

  4. go to Github Repo Home page -> Tags -> Releases -> Draft a new release.

    a) create a new tag via "Choose a tag" autocomplete

    b) select "develop" branch as a target

    c) click the "Generate release notes" button, remove unnecessary notes if necessary, check PR messages and correct the messages if necessary (via PR editing)

    d) select "main" branch as a target

    e) click the "Publish release"

  5. check 'project-publish.yml' job result (Github Actions)

  6. checkout "develop" and pull, then merge "main" into "develop" and push

  7. update RELEASE-NOTES.md with using generated notes in step 4, create PR with from "common/release-notes-update-vX.X.X" to "develop" message "[Common] RELEASE-NOTES.md update vX.X.X"

Repository

Link to repository https://github.com/a1exevs/ts-guards.