chore: initial commit

Author: iamludal

.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+yarn-error.log

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "arrowParens": "avoid",
+  "semi": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false
+}

README.md

@@ -0,0 +1,52 @@
+# semantic-release-jira-notes
+
+[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to add links to
+JIRA issues in the release notes.
+
+[![npm latest version](https://img.shields.io/npm/v/semantic-release-jira-notes/latest.svg)](https://www.npmjs.com/package/semantic-release-jira-notes)
+
+
+| Step               | Description                                          |
+| ------------------ | ---------------------------------------------------- |
+| `verifyConditions` | Validate the config options                          |
+| `generateNotes`    | Generate the release notes with links to JIRA issues |
+
+
+## Usage
+
+First, install the plugin.
+
+```bash
+$ npm install --save-dev semantic-release-jira-notes
+$ yarn add --dev semantic-release-jira-notes
+```
+
+
+## Configuration
+
+The plugin should then be added to your config file.
+
+```json
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    ["semantic-release-jira-notes", {
+      "jiraHost": "iamludal.atlassian.net",
+      "ticketPrefixes": ["ATP", "OMS"], // optional
+    }]
+    "@semantic-release/git",
+    "@semantic-release/github"
+  ]
+}
+```
+
+**Note:** you don't need to use `@semantic-release/release-notes-generator` as it already uses
+it under the hood.
+
+
+### Inputs
+
+| Name           | Required | Description                                                            |
+| -------------- | :------: | ---------------------------------------------------------------------- |
+| jiraHost       |    ✅     | Your JIRA host domain name                                             |
+| ticketPrefixes |    ❌     | Ticket prefixes to match. If not provided, match all tickets prefixes. |

package.json

@@ -0,0 +1,13 @@
+{
+  "name": "semantic-release-jira-notes",
+  "version": "1.0.0",
+  "description": "Semantic Release plugin to add JIRA issues link to the release notes",
+  "main": "src/index.js",
+  "author": "iamludal",
+  "license": "MIT",
+  "dependencies": {
+    "@semantic-release/error": "2.2.0",
+    "@semantic-release/release-notes-generator": "^10.0.3",
+    "aggregate-error": "^4.0.1"
+  }
+}

src/index.js

@@ -0,0 +1,4 @@
+const verifyConditions = require("./lib/verify-conditions");
+const generateNotes = require("./lib/generate-notes");
+
+module.exports = { verifyConditions, generateNotes };

src/lib/constants.js

@@ -0,0 +1,7 @@
+const INPUTS = { ticketPrefixes: "ticketPrefixes", jiraHost: "jiraHost" };
+
+const TICKET_PREFIX_REGEX = /^[A-Z][A-Z0-9]{0,50}$/;
+const ISSUE_REGEX = /([A-Z][A-Z0-9]{0,50}-[1-9][0-9]*)/;
+const DOMAIN_NAME_REGEX = /^((?!-)[A-Za-z0-9-]{1,63}(?<!-)\.)+[A-Za-z]{2,6}$/;
+
+module.exports = { INPUTS, TICKET_PREFIX_REGEX, ISSUE_REGEX, DOMAIN_NAME_REGEX };

src/lib/errors.js

@@ -0,0 +1,21 @@
+const SemanticReleaseError = require("@semantic-release/error");
+
+class RegexError extends SemanticReleaseError {
+  constructor(value, pattern) {
+    super(`Value '${value}' does not match regex: ${pattern}`);
+  }
+}
+
+class InvalidTypeError extends SemanticReleaseError {
+  constructor(variableName, expectedType) {
+    super(`${variableName} should be of type: ${expectedType}`);
+  }
+}
+
+class InputRequiredError extends SemanticReleaseError {
+  constructor(inputName) {
+    super(`Input '${inputName}' is required`);
+  }
+}
+
+module.exports = { RegexError, InvalidTypeError, InputRequiredError };

src/lib/generate-notes.js

@@ -0,0 +1,20 @@
+const releaseNotesGenerator = require("@semantic-release/release-notes-generator");
+const { INPUTS, ISSUE_REGEX } = require("./constants");
+
+module.exports = async (pluginConfig, context) => {
+  const ticketPrefixes = pluginConfig[INPUTS.ticketPrefixes];
+  const jiraHost = pluginConfig[INPUTS.jiraHost];
+  const notes = await releaseNotesGenerator.generateNotes(pluginConfig, context);
+
+  let issueRegex;
+
+  if (!ticketPrefixes) {
+    issueRegex = new RegExp(ISSUE_REGEX, "g");
+  } else if (ticketPrefixes.length > 0) {
+    issueRegex = new RegExp(`((${ticketPrefixes.join("|")})-[1-9][0-9]*)`, "g");
+  } else {
+    return notes;
+  }
+
+  return notes?.replace(issueRegex, `[$1](https://${jiraHost}/browse/$1)`);
+};

src/lib/verify-conditions.js

@@ -0,0 +1,34 @@
+const { InputRequiredError, RegexError } = require("./errors");
+const SemanticReleaseError = require("@semantic-release/error");
+const AggregateErrorPromise = import("aggregate-error");
+const constants = require("./constants");
+
+const { INPUTS, TICKET_PREFIX_REGEX, DOMAIN_NAME_REGEX } = constants;
+
+module.exports = async pluginConfig => {
+  const ticketPrefixes = pluginConfig[INPUTS.ticketPrefixes] ?? [];
+  const jiraHost = pluginConfig[INPUTS.jiraHost];
+  const errors = [];
+
+  const AggregateError = (await AggregateErrorPromise).default;
+
+  if (!Array.isArray(ticketPrefixes)) {
+    errors.push(new SemanticReleaseError(INPUTS.ticketPrefixes, Array.name));
+  } else {
+    for (const prefix of ticketPrefixes) {
+      if (!TICKET_PREFIX_REGEX.test(prefix)) {
+        errors.push(new RegexError(prefix, TICKET_PREFIX_REGEX));
+      }
+    }
+  }
+
+  if (!jiraHost) {
+    errors.push(new InputRequiredError(INPUTS.jiraHost));
+  } else if (!DOMAIN_NAME_REGEX.test(jiraHost)) {
+    errors.push(new RegexError(jiraHost, DOMAIN_NAME_REGEX));
+  }
+
+  if (errors.length > 0) {
+    throw new AggregateError(errors);
+  }
+};