{"_id":"@davidspekorg/semantic-release-jira-releases-modern","_rev":"1-e2b1d1409244f2dbde6203a447e1f6a0","name":"@davidspekorg/semantic-release-jira-releases-modern","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@davidspekorg/semantic-release-jira-releases-modern","version":"1.0.0","license":"MIT","_id":"@davidspekorg/semantic-release-jira-releases-modern@1.0.0","maintainers":[{"name":"davidspek","email":"vanderspek.david@gmail.com"}],"homepage":"https://github.com/davidspek/semantic-release-jira-releases-modern#readme","bugs":{"url":"https://github.com/davidspek/semantic-release-jira-releases-modern/issues"},"dist":{"shasum":"e87e71cfe6e56920c14e6372d850d87c49e096fe","tarball":"https://registry.npmjs.org/@davidspekorg/semantic-release-jira-releases-modern/-/semantic-release-jira-releases-modern-1.0.0.tgz","fileCount":16,"integrity":"sha512-Na1VY2gtjuv2smb7OG3fXnmMJhgqjv1IBNQ/21f9Y2TNFZINpih6j3ClT6cvFKf7CmhtKhWZekrq/ggT4ZufkQ==","signatures":[{"sig":"MEUCIQDlNllaOG9re2JOXP+422NAiGkL7K5T6SzuRBK68einZwIgZQ8LILgsswgjk+rI0ssuGD3x1Qegb6U/Ck5OId3BPq8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":31857},"main":"./dist/index.js","types":"./lib/index.ts","gitHead":"a61d8caa38d4abf66b269593ddd7e82cb0ee7e20","scripts":{"lint":"biome format ./lib ./test && biome lint ./lib ./test","test":"yarn jest","build":"tsc -p .","format":"biome format --write ./lib ./test && biome lint --write --unsafe ./lib ./test","type-check":"tsc --noEmit"},"_npmUser":{"name":"davidspek","email":"vanderspek.david@gmail.com"},"repository":{"url":"git+https://github.com/davidspek/semantic-release-jira-releases-modern.git","type":"git"},"_npmVersion":"10.9.1","description":"[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a jira release.","directories":{},"_nodeVersion":"22.12.0","dependencies":{"tslib":"1.14.1","lodash":"4.17.21","jira.js":"4.0.2","p-limit":"2.3.0","@semantic-release/error":"2.2.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"packageManager":"yarn@4.1.1","devDependencies":{"jest":"29.7.0","esbuild":"0.24.0","typescript":"5.7.2","@types/jest":"29.5.14","esbuild-jest":"0.5.0","@types/lodash":"4.17.13","@biomejs/biome":"1.9.4","@types/request":"2.48.12","@types/signale":"1.4.7","esbuild-register":"3.6.0","semantic-release":"24.2.0","@semantic-release/git":"10.0.1","@semantic-release/npm":"12.0.1","@semantic-release/exec":"6.0.3","@semantic-release/github":"11.0.1","@semantic-release/changelog":"6.0.3","@types/semantic-release__error":"3.0.3"},"_npmOperationalInternal":{"tmp":"tmp/semantic-release-jira-releases-modern_1.0.0_1735637226673_0.8513030725134825","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@davidspekorg/semantic-release-jira-releases-modern","version":"1.1.0","packageManager":"yarn@4.1.1","main":"./dist/index.js","types":"./lib/index.ts","repository":{"type":"git","url":"git+https://github.com/davidspek/semantic-release-jira-releases-modern.git"},"license":"MIT","publishConfig":{"access":"public"},"scripts":{"type-check":"tsc --noEmit","format":"biome format --write ./lib ./test && biome lint --write --unsafe ./lib ./test","lint":"biome format ./lib ./test && biome lint ./lib ./test","build":"tsc -p .","test":"yarn jest"},"dependencies":{"@semantic-release/error":"2.2.0","jira.js":"4.0.2","lodash":"4.17.21","p-limit":"2.3.0","tslib":"1.14.1"},"devDependencies":{"@biomejs/biome":"1.9.4","@semantic-release/changelog":"6.0.3","@semantic-release/exec":"6.0.3","@semantic-release/git":"10.0.1","@semantic-release/github":"11.0.1","@semantic-release/npm":"12.0.1","@types/jest":"29.5.14","@types/lodash":"4.17.13","@types/request":"2.48.12","@types/semantic-release__error":"3.0.3","@types/signale":"1.4.7","esbuild":"0.24.0","esbuild-jest":"0.5.0","esbuild-register":"3.6.0","jest":"29.7.0","semantic-release":"24.2.0","typescript":"5.7.2"},"_id":"@davidspekorg/semantic-release-jira-releases-modern@1.1.0","gitHead":"aa851569a3a36783a9cd3bc5f470ac1f90fe4b8d","description":"[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a jira release.","bugs":{"url":"https://github.com/davidspek/semantic-release-jira-releases-modern/issues"},"homepage":"https://github.com/davidspek/semantic-release-jira-releases-modern#readme","_nodeVersion":"22.12.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-C2s8Ml03Hq1idA9JpxYIdfCUvecoOF4OC1pw7xYql1a45/3VQjijbruArYpVTLMnICiulyQ8V57iR6P4OE9AMg==","shasum":"558c70bce176f5650f64b1cb5d7503c47e0e893a","tarball":"https://registry.npmjs.org/@davidspekorg/semantic-release-jira-releases-modern/-/semantic-release-jira-releases-modern-1.1.0.tgz","fileCount":16,"unpackedSize":32799,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC11O6VMZbF9tdSpSDpl3R5QjgM6cmjX/IhM9dt51IpwQIgS+wTY5dPXPRsfb/3Zt20wIqX8+xb83YC5gzbWeRl0rY="}]},"_npmUser":{"name":"davidspek","email":"vanderspek.david@gmail.com"},"directories":{},"maintainers":[{"name":"davidspek","email":"vanderspek.david@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/semantic-release-jira-releases-modern_1.1.0_1735637492495_0.49168569927424466"},"_hasShrinkwrap":false}},"time":{"created":"2024-12-31T09:27:06.551Z","modified":"2024-12-31T09:31:32.842Z","1.0.0":"2024-12-31T09:27:06.841Z","1.1.0":"2024-12-31T09:31:32.665Z"},"bugs":{"url":"https://github.com/davidspek/semantic-release-jira-releases-modern/issues"},"license":"MIT","homepage":"https://github.com/davidspek/semantic-release-jira-releases-modern#readme","repository":{"type":"git","url":"git+https://github.com/davidspek/semantic-release-jira-releases-modern.git"},"description":"[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a jira release.","maintainers":[{"name":"davidspek","email":"vanderspek.david@gmail.com"}],"readme":"# semantic-release-jira-releases-modern\n\n[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a jira release.\n\n[![npm latest version](https://img.shields.io/npm/v/semantic-release-jira-releases-modern/latest.svg)](https://www.npmjs.com/package/semantic-release-jira-releases-modern)\n\n\n| Step               | Description                                                                                                                                   |\n|--------------------|----------------------------------------------------------------------------|\n| `verifyConditions` | Validate the config options and check for a `JIRA_USER,JIRA_TOKEN` in the environment |\n| `sucess`           | Find all tickets from commits and add them to a new release on JIRA        |\n\n## Install\n\n```bash\n$ npm install --save-dev semantic-release-jira-releases-modern\n$ yarn add --dev semantic-release-jira-releases-modern\n```\n\n### Configuration\nThe plugin should be added to your config\n```json\n{\n  \"plugins\": [\n    \"@semantic-release/commit-analyzer\",\n    \"@semantic-release/release-notes-generator\",\n    \"@semantic-release/git\",\n    [\"semantic-release-jira-releases-modern\", {\n      \"projectId\": \"UH\",\n      \"releaseNameTemplate\": \"Test v${version}\",\n      \"jiraHost\": \"your-company.atlassian.net\",\n      \"ticketPrefixes\": [ \"TEST\", \"UH\"],\n      \"ticketRegex\": \"[a-zA-Z]{3,5}-\\\\d{3,5}\"\n    }]\n  ]\n}\n\nPlease note that `ticketRegex` cannot be used together with `ticketPrefixes`.\n```\n```typescript\nexport interface Config {\n  /**\n   * A domain of a jira instance ie: `your-company.atlassian.net`\n   */\n  jiraHost: string;\n\n  /**\n   * A list of prefixes to match when looking for tickets in commits. Cannot be used together with ticketRegex.\n   *\n   * ie. ['TEST'] would match `TEST-123` and `TEST-456`\n   */\n  ticketPrefixes?: string[];\n\n  /**\n   * A unescaped regex to match tickets in commits (without slashes). Cannot be used together with ticketPrefixes.\n   *\n   * ie. [a-zA-Z]{4}-\\d{3,5} would match any ticket with 3 letters a dash and 3 to 5 numbers, such as `TEST-456`, `TEST-5643` and `TEST-56432`\n   */\n  ticketRegex?: string;\n\n  /**\n   * The id or key for the project releases will be created in\n   */\n  projectId: string;\n\n  /**\n   * A lodash template with a single `version` variable\n   * defaults to `v${version}` which results in a version that is named like `v1.0.0`\n   * ex: `Semantic Release v${version}` results in `Semantic Release v1.0.0`\n   *\n   * @default `v${version}`\n   */\n  releaseNameTemplate?: string;\n\n  /**\n   * A lodash template for the release.description field\n   *\n   * template variables:\n   *    version: the sem-ver version ex.: 1.2.3\n   *      notes: The full release notes: This may be very large\n   *             Only use it if you have very small releases\n   *\n   * @default `Automated release with semantic-release-jira-releases-modern`\n   */\n  releaseDescriptionTemplate?: string;\n\n  /**\n   * The number of maximum parallel network calls, default 10\n   */\n  networkConcurrency?: number;\n\n  /**\n   * indicates if a new release created in jira should be set as released\n   */\n  released?: boolean;\n  /**\n   * include the release date when creating a release in jira\n   */\n  setReleaseDate?: boolean;\n  /**\n   * ignore ticket numbers in the branch name\n   */\n  disableBranchFiltering?: boolean;\n}\n```\n\n### What is searched for the ticket prefix?\n\nWe search commit bodies for a commit number and we look at the branch name as well. This means that a branch named `TEST-345-anything` with a commit `feat: thing \\n TEST-123` will add a release named after the new version and link both `TEST-123` and `TEST-345` to it. This is done as a lot of the github/gitlab integrations support the branch naming to match to tickets so we want to broadly reproduce these features to reduce developer cognitive overload. Can be disabled via `disableBranchFiltering`.\n","readmeFilename":"README.md"}