ci: setup conventional commits & release automation

.commitlintrc

@@ -0,0 +1,5 @@
+{
+	"extends": [
+		"@insurgentlab/commitlint-config"
+	]
+}

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+<!--- Provide a general summary of your changes in the Title above (following the Conventional Commits standard) -->
+<!-- More infos: https://www.conventionalcommits.org -->
+<!-- Commit types: https://github.com/insurgent-lab/conventional-changelog-preset#commit-types-->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Related Issue
+<!--- This project only accepts pull requests related to open issues -->
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Screenshots (if appropriate):
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.
+- [ ] If my change introduces a breaking change, I have added a `!` after the type/scope in the title (see the Conventional Commits standard).

.github/workflows/lint_pr_title.yml

@@ -0,0 +1,45 @@
+name: 'Lint PR title'
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  pull-requests: write
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        id: lint_pr_title
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        # When the previous steps fails, the workflow would stop. By adding this
+        # condition you can continue the execution with the populated error message.
+        if: always() && (steps.lint_pr_title.outputs.error_message != null)
+        with:
+          header: pr-title-lint-error
+          message: |
+            Hey there and thank you for opening this pull request! 👋🏼
+
+            We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
+
+            Details:
+
+            ```
+            ${{ steps.lint_pr_title.outputs.error_message }}
+            ```
+
+      # Delete a previous comment when the issue has been resolved
+      - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: pr-title-lint-error
+          delete: true

.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Test & Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  lint-and-test:
+    uses: ./.github/workflows/test.yml
+    secrets: inherit
+
+  release:
+    needs: lint-and-test
+
+    runs-on: ubuntu-latest
+    env:
+      node-version: 18.x
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - name: Use Node.js ${{ env.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.node-version }}
+      - name: Install packages
+        run: npm ci
+      - name: Run Semantic Release
+        run: npm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.CI_GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Lint & Test
+
+on:
+  workflow_call:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  lint-and-test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node: [14.x, 16.x, 18.x]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install packages
+        run: npm ci
+      - name: Check codestyle compliance
+        run: npm run lint
+      - name: Run tests
+        run: npm run test
+        env:
+          CI: true

.husky/commit-msg

@@ -0,0 +1,11 @@
+#!/usr/bin/env sh
+
+# https://typicode.github.io/husky/guide.html#disable-husky-in-ci-docker-prod
+[ -n "$CI" ] && exit 0
+
+# only run commitlint on master (for admins pushing directly to branch)
+[ "$(git rev-parse --abbrev-ref HEAD)" != "master" ] && exit 0
+
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

.releaserc

@@ -0,0 +1,41 @@
+{
+	"repositoryUrl": "git@github.com:kelektiv/node-cron.git",
+	"branches": [
+		"master"
+	],
+	"tagFormat": "v${version}",
+	"plugins": [
+		[
+			"@semantic-release/commit-analyzer",
+			{
+				"config": "@insurgentlab/conventional-changelog-preset",
+				"releaseRules": "@insurgentlab/conventional-changelog-preset/release-rules"
+			}
+		],
+		[
+			"@semantic-release/release-notes-generator",
+			{
+				"config": "@insurgentlab/conventional-changelog-preset"
+			}
+		],
+		"@semantic-release/npm",
+		[
+			"@semantic-release/changelog",
+			{
+				"changelogFile": "CHANGELOG.md"
+			}
+		],
+		[
+			"@semantic-release/git",
+			{
+				"assets": [
+					"CHANGELOG.md",
+					"package.json",
+					"package-lock.json"
+				],
+				"message": "Release v${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+			}
+		],
+		"@semantic-release/github"
+	]
+}

CHANGELOG.md

@@ -1,4 +1,4 @@
-## [v2.3.1]
+## [v2.3.1](https://github.com/kelektiv/node-cron/compare/v2.3.0...v2.3.1) (2023-05-25)
 
 ### Added
 
@@ -9,7 +9,7 @@
 
 - Linting issues
 
-## [v2.3.0]
+## [v2.3.0](https://github.com/kelektiv/node-cron/compare/v2.2.0...v2.3.0) (2023-03-14)
 
 ### Fixed
 
@@ -19,38 +19,38 @@
 
 - Refactored get next date function
 
-## [v2.2.0]
+## [v2.2.0](https://github.com/kelektiv/node-cron/compare/v2.1.0...v2.2.0) (2023-01-09)
 
 ### Changed
 
 - Updated Luxon dependency
 - Updated unit tests to be compatible with new Luxon version
 
-## [v2.1.0]
+## [v2.1.0](https://github.com/kelektiv/node-cron/compare/v2.0.0...v2.1.0) (2022-07-14)
 
 ### Changed
 
 - "Maximum iterations" will direct the user to refer to a single canonical issue instead of creating a new one
 
-## [v2.0.0] - 2022-05-03
+## [v2.0.0](https://github.com/kelektiv/node-cron/compare/v1.8.2...v2.0.0) (2022-05-03)
 - Upgrade vulnerable dependencies
 - Move from moment.js to luxon (breaking change)
 
-## [v1.8.2] - 2020-01-24
+## [v1.8.2](https://github.com/kelektiv/node-cron/compare/v1.8.1...v1.8.2) (2020-01-24)
 - Fix syntax parsing bug
 
-## [v1.8.1] - 2020-01-19
+## [v1.8.1](https://github.com/kelektiv/node-cron/compare/v1.8.0...v1.8.1) (2020-01-19)
 - Revert TS definition defaulting to DefinitelyTyped definitions.
 
-## [v1.8.0] - 2020-01-19
+## [v1.8.0](https://github.com/kelektiv/node-cron/compare/v1.7.1...v1.8.0) (2020-01-19)
 - GH-454 - Range upper limit should default to highest value when step is provided by Noah May <noahmouse2011@gmail.com> in d36dc9581f9f68580a2016b368f8002a9f1e357d
 
-## [v1.7.1] - 2019-04-26
+## [v1.7.1](https://github.com/kelektiv/node-cron/compare/v1.7.0...v1.7.1) (2019-04-26)
 - GH-416 - Fix issue where next execution time is incorrect in some cases in Naoya Inada <naoina@kuune.org> in c08522ff80b3987843e9930c307b76d5fe38b5dc
 
-## [v1.7.0] - 2019-03-19
+## [v1.7.0](https://github.com/kelektiv/node-cron/compare/v1.6.0...v1.7.0) (2019-03-19)
 - GH-408 - DST issue by Shua Talansky <shua@bitbean.com> in 1e971fd6dfa6ba4b0469d99dd64e6c31189d17d3 and 849a2467d16216a9dfa818c57cc26be6b6d0899b
 
-## [v1.6.0] - 2018-11-15
+## [v1.6.0](https://github.com/kelektiv/node-cron/compare/v1.5.1...v1.6.0) (2018-11-15)
 - GH-393, GH-394 - Remove hard limit on max iters in favor of a timeout by Nick Campbell <nicholas.j.campbell@gmail.com> in 57632b0c06c56e82f40b740b8d7986be43842735
 - GH-390 - better handling of real dates which are in the past by Nick Campbell <nicholas.j.campbell@gmail.com> in 7cbcc984aea6ec063e38829f68eb9bc0dfb1c775