# @davidspekorg/semantic-release-jira-releases-modern 中文文档

规范地址：https://npmcn.com/package/%40davidspekorg/semantic-release-jira-releases-modern/

版本：1\.1\.0
npm 元数据更新时间：2024-12-31T09:31:32.842Z
中文译文更新时间：2026-11-11T17:03:54.753Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40davidspekorg/semantic-release-jira-releases-modern
原文对照：https://npmcn.com/package/%40davidspekorg/semantic-release-jira-releases-modern/?lang=original
项目主页：https://github.com/davidspek/semantic-release-jira-releases-modern#readme
源码仓库：https://github.com/davidspek/semantic-release-jira-releases-modern

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：32.8 kB，16 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2024-12-31T09:27:06.551Z
- 最新版本发布：2024-12-31T09:31:32.665Z
- 近 30 天下载量：5973（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

[**语义释放**](https://github.com/semantic-release/semantic-release) 发布 jira 发行的插件 .

## 安装

```sh
npm install @davidspekorg/semantic-release-jira-releases-modern
```

也可以使用：`pnpm add @davidspekorg/semantic-release-jira-releases-modern`、`yarn add @davidspekorg/semantic-release-jira-releases-modern`、`bun add @davidspekorg/semantic-release-jira-releases-modern`

## README

# 语义-放行-jira-放行-现代

[**语义释放**](https://github.com/semantic-release/semantic-release) 发布 jira 发行的插件 .

[![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)

| 步骤 | 说明 |
| --- | --- |
| `verifyConditions` | 验证配置选项并检查 `JIRA_USER,JIRA_TOKEN` 环境状况 |
| `sucess` | 找到所有承诺的门票 并添加到JIRA的新释放中 |

## 安装

```bash
$ npm install --save-dev semantic-release-jira-releases-modern
$ yarn add --dev semantic-release-jira-releases-modern
```

### 配置

插件应该添加到您的配置中

```json
{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/git",
    ["semantic-release-jira-releases-modern", {
      "projectId": "UH",
      "releaseNameTemplate": "Test v${version}",
      "jiraHost": "your-company.atlassian.net",
      "ticketPrefixes": [ "TEST", "UH"],
      "ticketRegex": "[a-zA-Z]{3,5}-\\d{3,5}"
    }]
  ]
}

Please note that `ticketRegex` cannot be used together with `ticketPrefixes`.
```

```typescript
export interface Config {
  /**
   * A domain of a jira instance ie: `your-company.atlassian.net`
   */
  jiraHost: string;

  /**
   * A list of prefixes to match when looking for tickets in commits. Cannot be used together with ticketRegex.
   *
   * ie. ['TEST'] would match `TEST-123` and `TEST-456`
   */
  ticketPrefixes?: string[];

  /**
   * A unescaped regex to match tickets in commits (without slashes). Cannot be used together with ticketPrefixes.
   *
   * 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`
   */
  ticketRegex?: string;

  /**
   * The id or key for the project releases will be created in
   */
  projectId: string;

  /**
   * A lodash template with a single `version` variable
   * defaults to `v${version}` which results in a version that is named like `v1.0.0`
   * ex: `Semantic Release v${version}` results in `Semantic Release v1.0.0`
   *
   * @default `v${version}`
   */
  releaseNameTemplate?: string;

  /**
   * A lodash template for the release.description field
   *
   * template variables:
   *    version: the sem-ver version ex.: 1.2.3
   *      notes: The full release notes: This may be very large
   *             Only use it if you have very small releases
   *
   * @default `Automated release with semantic-release-jira-releases-modern`
   */
  releaseDescriptionTemplate?: string;

  /**
   * The number of maximum parallel network calls, default 10
   */
  networkConcurrency?: number;

  /**
   * indicates if a new release created in jira should be set as released
   */
  released?: boolean;
  /**
   * include the release date when creating a release in jira
   */
  setReleaseDate?: boolean;
  /**
   * ignore ticket numbers in the branch name
   */
  disableBranchFiltering?: boolean;
}
```

### 车票前缀是什么?

我们搜索承诺机构 寻找承诺数字,我们也看看分支名称。 这意味着一个分支命名为 `TEST-345-anything` 与犯罪 `feat: thing \n TEST-123` 将添加以新版本命名的版本,并将两者链接 `TEST-123` 财务报告和审定财务报表 `TEST-345` 对它。 这样做是因为很多github/gitlab的集成支持分支命名与门票相匹配,所以我们希望广泛复制这些功能来减少开发者认知超载. 可以通过 `disableBranchFiltering`。 。 。 .

## 常见问题

### @davidspekorg/semantic-release-jira-releases-modern 是什么？

语义释放 发布 jira 发行的插件 \.

### 如何安装 @davidspekorg/semantic-release-jira-releases-modern？

在项目目录运行 npm install @davidspekorg/semantic-release-jira-releases-modern，或使用 pnpm add / yarn add / bun add。

### @davidspekorg/semantic-release-jira-releases-modern 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @davidspekorg/semantic-release-jira-releases-modern 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @davidspekorg/semantic-release-jira-releases-modern 可以商用吗？

@davidspekorg/semantic-release-jira-releases-modern 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @davidspekorg/semantic-release-jira-releases-modern 的下载量有多少？

根据 npm 官方下载统计，@davidspekorg/semantic-release-jira-releases-modern 在 2026/10/12 – 2026/11/10 这 30 天内被下载 5,973 次，日均约 199 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @davidspekorg/semantic-release-jira-releases-modern 还在维护吗？

最新版本 1\.1\.0 发布于 2024/12/31（1\.9 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2024/12/31。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

