@devpow112/semantic-release-config 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Devon Powell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# Semantic Release Configuration
+
+[![License][License Badge]](LICENSE)
+[![Version][Version Badge]][Version Package]
+[![CI][CI Badge]][CI Workflow]
+[![Release][Release Badge]][Release Workflow]
+[![Vulnerabilities][Vulnerabilities Badge]][Vulnerabilities Report]
+[![Node Version][Node Version Badge]](package.json#L35)
+
+Shareable Semantic Release configuration.
+
+## Installation
+
+```sh
+npm i -D @devpow112/semantic-release-config
+```
+
+## Usage
+
+The shareable config can be configured in the [Semantic Release Configuration]
+file.
+
+```json
+{
+  "extends": "@devpow112/semantic-release-config"
+}
+```
+
+## Development
+
+Development can be done on any machine that can install **Node.js**. Only the
+latest LTS version is tested against.
+
+### Install Dependencies
+
+Install dependencies via `npm`.
+
+```sh
+npm i
+```
+
+### Linting
+
+Execute linters via `npm`.
+
+```sh
+# git, javascript and markdown
+npm run lint
+
+# git only
+npm run lint:git
+
+# javascript only
+npm run lint:js
+
+# markdown only
+npm run lint:md
+```
+
+### Formatting
+
+Execute formatters via `npm`.
+
+```sh
+# javascript and markdown
+npm run format
+
+# javascript only
+npm run format:js
+
+# markdown only
+npm run format:md
+```
+
+<!-- links -->
+[License Badge]: https://img.shields.io/github/license/devpow112/semantic-release-config?label=License
+[Version Badge]: https://img.shields.io/npm/v/@devpow112/semantic-release-config?label=Version
+[Version Package]: https://www.npmjs.com/@devpow112/semantic-release-config
+[Node Version Badge]: https://img.shields.io/node/v/@devpow112/semantic-release-config
+[CI Badge]: https://github.com/devpow112/semantic-release-config/actions/workflows/ci.yml/badge.svg?branch=main
+[CI Workflow]: https://github.com/devpow112/semantic-release-config/actions/workflows/ci.yml?query=branch%3Amain
+[Release Badge]: https://github.com/devpow112/semantic-release-config/actions/workflows/release.yml/badge.svg?branch=main
+[Release Workflow]: https://github.com/devpow112/semantic-release-config/actions/workflows/release.yml?query=branch%3Amain
+[Vulnerabilities Badge]: https://img.shields.io/snyk/vulnerabilities/github/devpow112/semantic-release-config?label=Vulnerabilities
+[Vulnerabilities Report]: https://snyk.io/test/github/devpow112/semantic-release-config
+[Semantic Release Configuration]: https://semantic-release.gitbook.io/semantic-release/usage/shareable-configurations

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@devpow112/semantic-release-config",
+  "version": "1.0.0",
+  "description": "Shareable semantic release configuration",
+  "main": "src/config.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "run-s -s lint:git lint:js lint:md",
+    "lint:js": "eslint .",
+    "lint:md": "markdownlint .",
+    "lint:git": "commitlint --from origin/main --to HEAD",
+    "format": "run-s -s format:js format:md",
+    "format:js": "npm run -s lint:js -- --fix",
+    "format:md": "npm run -s lint:md -- --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/devpow112/semantic-release-config.git"
+  },
+  "keywords": [
+    "semantic-release-config"
+  ],
+  "author": "Devon Powell <devon.f.powell@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/devpow112/semantic-release-config/issues"
+  },
+  "homepage": "https://github.com/devpow112/semantic-release-config#readme",
+  "files": [
+    "src/**/*.js"
+  ],
+  "engines": {
+    "node": ">=12.22.7",
+    "npm": ">=6.14.15"
+  },
+  "peerDependencies": {
+    "@semantic-release/git": "^10.0.1",
+    "conventional-changelog-conventionalcommits": "^4.6.3",
+    "semantic-release": "^19.0.2"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^16.1.0",
+    "@commitlint/config-conventional": "^16.0.0",
+    "@devpow112/eslint-config": "^1.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "conventional-changelog-conventionalcommits": "^4.6.3",
+    "eslint": "^8.8.0",
+    "markdownlint-cli": "^0.31.1",
+    "npm-run-all": "^4.1.5",
+    "semantic-release": "^19.0.2"
+  }
+}

package/src/config.js

@@ -0,0 +1,51 @@
+module.exports = {
+  branches: ['main'],
+  plugins: [
+    [
+      '@semantic-release/commit-analyzer',
+      {
+        preset: 'conventionalcommits',
+        releaseRules: [
+          { type: 'chore', scope: 'deps', release: 'patch' },
+          { type: 'refactor', release: 'patch' }
+        ]
+      }
+    ],
+    [
+      '@semantic-release/github',
+      {
+        labels: ['auto'],
+        releasedLabels: ['released'],
+        assignees: ['devpow112'],
+        addReleases: 'top'
+      }
+    ],
+    '@semantic-release/npm',
+    [
+      '@semantic-release/release-notes-generator',
+      {
+        preset: 'conventionalcommits',
+        presetConfig: {
+          types: [
+            { type: 'feat', section: 'Features' },
+            { type: 'fix', section: 'Bug Fixes' },
+            { type: 'perf', section: 'Performance Improvements' },
+            { type: 'revert', section: 'Reverts' },
+            { type: 'docs', section: 'Documentation' },
+            { type: 'chore', section: 'Miscellaneous Chores' },
+            { type: 'refactor', section: 'Code Refactoring' },
+            { type: 'test', section: 'Tests' },
+            { type: 'build', section: 'Build System' }
+          ]
+        }
+      }
+    ],
+    [
+      '@semantic-release/git',
+      {
+        assets: ['package.json', 'package-lock.json'],
+        message: 'chore(release): ${nextRelease.version}'
+      }
+    ]
+  ]
+};