@retestify-test-nts

NTC (NODE - TSUP - SEMANTIC-RELEASE w/ COMMITIZEN)

Format: [Framework] - [Bundler] - [Versioning] Only for testing purposes

Getting started

Installation

Install the package through any of the package managers:

# npm
npm i @retestify-test-nts

# yarn
yarn add @retestify-test-nts

# pnpm
pnpm add @retestify-test-nts

# bun
bun add @retestify-test-nts

Import Package

The package can be used by type common js or es modules

// cjs
const ntc = require("@retestify-test-nts");

// mjs
import ntc from "@retestify-test-nts";

Versioning Documentation

CURRENT VERSION: semantic-release: ^24.1.2

NOTE: MAKE SURE NOT TO MODIFY THE PACKAGE VERSION ONCE INITIALIZED

NOTE: All steps indicated here are not part of a standard procedure, as this is experimental.

Instructions:

• Follow the steps listed below even though they may not align with typical best practices.
• If you find areas of improvement, you are encouraged to submit a pull request to refine this experimental process. Otherwise, ensure that you comply with the rules as they are, without deviation.

Semantic Commit Options:

• Patch Release

# Formats:
# git commit -m "fix: [message]"
# git commit -m "fix([scope]): [message]"

git commit -m "fix: fix initial"
git commit -m "fix(index.js): fix index"
git commit -m "fix(dashboard): fix dashboard"

• Minor Release

# Any commit type other than "fix:"
# Typical commit type:
# feat(feature) | perf(performance) | ref(refactor) | rev(revert)
# docs(documents) | styles | build

# Formats:
# git commit -m "feat: [message]"
# git commit -m "feat([scope]): [message]"
# git commit -m "perf: [message]"
# git commit -m "perf([scope]): [message]"

git commit -m "feat: new feature"
git commit -m "feat(index.js): update feature"
git commit -m "rev(dashboard): revert commit"

• Major Release

# Any commit type with an "Exclamation (!)" or
# Any commit type with additional footer message "BREAKING CHANGE:" (NOTE: Capitalized)

# Formats:
# git commit -m "fix!: [message]"
# git commit -m "feat([scope])!: [message]"
# git commit -m "perf([scope]): [message]" -m "BREAKING CHANGE: [more-detailed-message]"
# git commit -m "ref([scope]): [message] BREAKING CHANGE: [more-detailed-message]"

git commit -m "fix!: a major fix"
git commit -m "feat(products)!: major update on products"
git commit -m "perf(cart): improved cart performance" -m "BREAKING CHANGE: improved cart performance on actions"
git commit -m "ref(orders): major refactor on orders BREAKING CHANGE: refactor orders with the new api"

Commitizen (Application):

# This is an cli that will make commits easier
git-cz
git cz
cz

NOTE: DO NOT COMMIT MANUALLY git commmit

• Add changes
• Use Comitizen to commit changes cz

Semantic Versioning Behavior:

By default, semantic-release does not update the package version (package.json), and its being handle automatically by semantic-release through git tags

• To enable semantic-release handle automatic versioning, set package.json version as a placeholder, use:
  • 0.0.0-development
  • 0.0.0-semantically-released

NOTE: MAKE SURE TO FOLLOW THE COMMIT FORMAT WHICH INCLUDES:

• Commit Format: type[colon]
• Commit type: fix, feat, perf!, etc.
• Commit Scope: fix(dasboard), feat(cart), perf(products)!, etc.
• Commit colon: fix(dasboard):, feat(cart):, perf(products)!:, etc.

Semantic's 1st major stable release (Behavior):

NOTE: a minor release at version 0.x

Semantic Config:

Create a release-config.js and copy as a template

/**
 * @type {import('semantic-release').GlobalConfig}
 */

module.exports = {
  branches: ["master", { name: "next", prerelease: true }],
};

Channel Release (Tags):

• Default: lastest
• Name: alpha, beta, next, dev
• Version [ N.N.x , N.x ]:
  • 1.0.x
  • 1.x

Range Types:

• N.N.x: [specified-number].[specified-number].[incremental]
• N.x: [specified-number].[incremental]

Branch Types:

• Release branch

// By default, channgel is "@latest" as dist-tag
//

//
module.exports = {
  branches: [
    // master => [email protected]
    "master",
    // next => [email protected]
    "next",
    // dev => [email protected]
    { name: "dev", channel: "development" },
  ],
};

• Maintenance branch

module.exports = {
  // 1.0.x => [package]@[email protected]
  // Start (1.0.0) | End (!>) 1.0.0
  // 1.0.[x] => 1.0.1 | 1.0.2
  { name: "1.0.x", range: "1.0.x", channel: "ch1.0.x" },

  // 2.x => [package]@[email protected]
  // Start (2.0.0) | End (!>) 3.0.0
  // 2.[x] => 2.1.0 | 2.1.1
  { name: "2.x", range: "2.x", channel: "ch2.x" },
};

• Pre-release branch

module.exports = {
  branches: [
    // master => [email protected]
    // master => [email protected]
    "master",
    { name: "alpha", prerelease: true }
    // next => [email protected]
    // next => [email protected]
    { name: "next", channel: "next", prerelease: "beta" }
  ],
};

Main Tag Behavoir:

Patch release

# current: latest tag: v1.2.3

# subsequent patch release
# v1.2.4
# v1.2.5
# v1.2.6

Minor release

# current: latest tag: v1.2.6

# subsequent minor release
# v1.3.0
# v1.4.0
# v1.5.0

Major release

# current: latest tag: v1.5.0

# subsequent major release
# v2.0.0
# v3.0.0
# v4.0.0

Pre-release Tag Behavoir:

Inititate pre-release next tag

# create branch next
git checkout -b next

# latest tag: v1.2.3
# next tag: v1.2.4-next.0

Subsequent patch releases

# patch commit
git commit -m "fix(cart): fix ui overlap"

# subsequent patch release: from v1.2.4-next-0
# v1.2.4-next.1
# v1.2.4-next.2
# v1.2.4-next.3

Subsequent minor releases

# minor commit
git commit -m "feat(order): new feature orders"

# subsequent minor release: from v1.2.4-next-3
# v1.3.0-next.0
# v1.3.0-next.1
# v1.3.0-next.2

Subsequent major releases

# major commit
git commit -m "perf(order)!: improved performance on orders"

# subsequent major release: from v1.3.0-next.2
# v2.0.0-next.0
# v2.0.0-next.1
# v2.0.0-next.2

Mixed releases

# major, patch, minor commit
git commit -m "feat(products)!: new feature products"
git commit -m "fix(table): fix table columns"
git commit -m "perf(dashboard): improve dashboard performance"

# subsequent release: from v4.0.0-next.2
# v5.0.0-next.0
# v5.0.1-next.0
# v5.1.0-next.0

Merge Pre-release to Latest Tag:

Patch release

git checkout master
git merge next

# latest tag: v1.2.3
# next tag: v1.2.4-next.2
# latest tag (merged): v1.2.4

Minor release

git checkout master
git merge next

# latest tag: v1.2.3
# next tag: v1.3.1-next.2
# latest tag (merged): v1.3.1

Major release

git checkout master
git merge next

# latest tag: v1.2.3
# next tag: v2.3.4-next.5
# latest tag (merged): v2.3.4

Pull Latest to Pre-releaes Tag:

Version Basis:

• Latest Tag: v1.2.4
• Next Tag: v1.2.4-next.2

No changes (latest)

# current: latest tag: v1.2.4

git checkout next
git pull master

# retatins current version
# pull: next tag: v1.2.4-next.2

# subsequent release: same process
# patch: v1.2.4-next.3
# minor: v1.3.0-next.0
# major: v2.0.0-next.0

Patch changes (latest)

# merge next to master
git checkout master
git merge master

# latest tag: v1.2.4
# next tag: v2.0.0-next.0
# merge: latest tag: v2.0.0

git commit -m "fix(ui): fix button color"
# latest tag: v2.0.1

git checkout next
git pull origin master

# copies latest tag version
# pull: next tag: v2.0.1

# subsequent release: same process
# patch: v2.0.1-next.0
# patch: v2.0.1-next.1
# patch: v2.0.1-next.2

Minor changes (latest)

# merge next to master
git checkout master
git merge master

# latest tag: v2.0.1
# next tag: v2.0.1-next.2
# merge: latest tag: v2.0.1

git commit -m "feat(sidebar): new feature sidebar"
# latest tag: v2.1.0

git checkout next
git pull origin master

# copies and append
# pull: next tag: v2.1.0-next.0

# subsequent release: same process
# patch: v2.1.0-next.1
# minor: v2.2.0-next.0
# major: v3.0.0-next.0
# minor: v3.1.0-next.0

Minor changes (latest)

# merge next to master
git checkout master
git merge master

# latest tag: v2.1.0
# next tag: v3.1.0-next.0
# merge: latest tag: v3.1.0

git commit -m "feat(dashboard)!: new feature dashboard"
# latest tag: v4.0.0

git checkout next
git pull origin master

# copies and append
# pull: next tag: v4.0.0-next.0

# subsequent release: same process
# patch: v4.0.1-next.1
# patch: v4.0.1-next.2
# patch: v4.0.1-next.3

LICENSE

MIT. See the LICENSE file.