@harnessio/backstage-plugin-ci-cd

中文文档
1.0.0发布于 2026/09/09Apache-2.0TypeScriptCommonJS近 30 天下载 5607

后台的Harness CI/CD插件. 1.0.0目标后台 1.53 /回放 18. 对更老的后台使用0.11x.

中文使用文档
文档目录8 节
  1. 版本兼容性
  2. 新的前端系统(后台1.53)
  3. 截图
  4. 开始
  5. 设置步骤
  6. 其他配置
  7. 特征
  8. 即将出现的特点

Harness NextGen CI/CD 插件

网站: https://harness.io/ (英语)

欢迎使用后台的Harness NextGen CI/CD插件!

版本兼容性

插件版本后台反应节点页:1
1.0.0 (单位:千美元) (本套装)1.53.x (韩语)第 18 条22或24条在后台1.53(如新前端系统)上为主机使用此功能.
0.11.x (英语)~1.21 时16/17 (中文(简体) )18/20 (中文(简体) )键 0.11.0 如果你不在后台1.50+. ^0.11.0 将 没有 安装 1.0.0.
# Backstage 1.53 / React 18
yarn add --cwd packages/app @harnessio/backstage-plugin-ci-cd@^1.0.0

# Older Backstage (keep existing installs)
yarn add --cwd packages/app @harnessio/[email protected]

不发布 1.53 仅更改为 0.11.x 或者说 0.12.x —— 说 ^0.11.0 把它们拉入旧的应用软件.

新的前端系统(后台1.53)

安装默认插件特性 :

import harnessCiCdPlugin from '@harnessio/backstage-plugin-ci-cd/alpha';

并添加到您的应用程序插件列表中 。 实体标签路径默认为 /harness-ci-cd。 。 。 .

遗产 EntityPage.tsx 下面的接线仍然在旧的前端系统上工作.

截图

开始

我们有插件的视频教程 .

Watch here

设置步骤

  1. 打开终端并导航到 后台应用程序的根运行
yarn add --cwd packages/app @harnessio/backstage-plugin-ci-cd@^1.0.0

yarn install

你要是想从后台开始,请检查一下 后台.io/docs。 。 。 .

为测试目的,您也可以克隆此寄存器来测试插件. 它包含一个实例后台应用程序设置,它与Harness插件一起预先安装. 然而,如果你想要从后台开始,你必须创建一个新的后台应用.

  1. 配置您所带的代理 app-config.yaml 下划线 proxy 相会. 添加您的个人访问键或服务账户键 x-api-key见 调理文件 用于生成 API 密钥.
# In app-config.yaml

proxy:
  # ... existing proxy settings
  '/harness/prod':
    target: 'https://app.harness.io/'
    headers:
      'x-api-key': '<YOUR PAT/SAT>'
# ...

注释:

  • 插件使用在这里配置的符号来调用 Harness API 。 确保创建此 API 令牌的用户拥有必要的权限,其中包括 project view 允许与 pipeline view 财务报告和审定财务报表 execute 对服务账户也适用同样的权限,它必须具有前文所述具有适当权限的任务.

  • 如果您正在使用 Harness 的 Prem 选项, 请将目标值设定为您的 oprem URL

  1. 在你的后台内 EntityPage.tsx,更新 cicdContent 构成部分 <EntityHarnessCiCdContent /> 当服务使用Harness CI/CD时。 像这样..
// In packages/app/src/components/catalog/EntityPage.tsx

import {
  isHarnessCiCdAvailable,
  EntityHarnessCiCdContent,
} from '@harnessio/backstage-plugin-ci-cd';

const cicdContent = (
  // ...
  <EntitySwitch.Case if={isHarnessCiCdAvailable}>
    <EntityHarnessCiCdContent />
  </EntitySwitch.Case>
  // ...
);

注意: 如果您除了Harness之外还有单独的 CI 和 CD 供应商, 您需要像下面这样为 Harness CI/ CD 插件添加一个新的标签, 而不是替换上面提到的您现有的 CI/ CD 标签 .

单独的 CI 和 CD 提供者的指令( 点击以扩展)
// In packages/app/src/components/catalog/EntityPage.tsx

import {
  isHarnessCiCdAvailable,
  EntityHarnessCiCdContent,
} from '@harnessio/backstage-plugin-ci-cd';

const serviceEntityPage = (
  // ...
  <EntityLayout.Route
    path="/harness-ci-cd"
    title="Harness CI/CD"
    if={isHarnessCiCdAvailable}
  >
    <EntityHarnessCiCdContent />
  </EntityLayout.Route>
  // ...
);
  1. 在您的软件组件中添加需要的调用说明 catalog-info.yaml 文档.

以下是一个例子: 目录- info-new.yaml

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  # ...
  annotations:
    # optional annotation
    harness.io/pipelines: |
      labelA: <harness_pipeline_url>
      labelB: <harness_pipeline_url>
    # here labelA / labelB denotes the value you will see in dropdown in execution list. Refer screentshot 1
    # optional annotation
    harness.io/services: |
      labelA: <harness_service_url>
      labelB: <harness_service_url>
spec:
  type: service
  # ...

旧注释

以下是一个例子: https://github.com/harness/后台-plugins/blob/main/examples/catalog-harness-cicd.yaml (中文(简体) )

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  # ...
  annotations:
    # mandatory annotation
    harness.io/project-url: <harness_project_url>

    # optional annotations
    # harness.io/ci-pipelineIds: <pipelineId1,pipelineId2,pipelineId3 etc>
    # harness.io/cd-serviceId: <serviceId>
spec:
  type: service
  # ...

注:如果出现新的注释,那么该特定目录的旧注释将被忽略.
注:参见 这个 关于如何从您的哈尼斯账户中获取这些值的页面.

默认情况下,插件会取出所配置的Harness项目内的所有管道并显示其执行. 然而,如果你的服务有几道静静的管道,你可以额外配置管道以及相关服务,以显示显示这些具体的执行细节.

其他配置

  • (可选)调用 URL

如果您有一个单独的 Harness 主机 URL 除外 https://app.harness.io,您可以配置 baseUrl 页:1 harness 内 app-config.yaml 这个步骤是可选的。 默认值为 harness.baseUrl 实值 https://app.harness.io/ 互联网档案馆的存檔,存档日期2011-12-21

# In app-config.yaml

harness:
  baseUrl: https://app.harness.io/
  • 启用/ 无法重新运行管道特性

默认情况下,后台用户将能够从插件中再运行管道. 然而,如果你的后台应用没有很好的RBAC政策,用户可以技术上重新运行任何服务的管道. 由于这个原因,我们有办法去除再运行的管道功能. 你可以通过配置来做到这一点 harness.disableRunPipeline。 。 。 .

# app-config.yaml

harness:
  # (Optional) Change it true to remove "Run Pipeline" option on the pipeline executions table
  disableRunPipeline: false

特征

  • 将后台服务与哈尼斯项目连接起来,并查看该项目中管道的50起处决.
  • 参见关于处决的详细情况 -- -- 处决状况、处决时间戳和所花时间、CI管道的相关触发器、CD管道的服务.
  • 指定管道ID(CI)或服务ID(CD),以缩小管道执行,在后台服务视图中显示.
  • 从插件中重试管道执行

即将出现的特点

检查 下一个里程碑 为 CI/CD 插件学习计划中的特性。 如果你有一些想法,想提供反馈, 请随意创建一个 新 GitHub 问题 并推荐一个特性请求.

版本与发布记录

@harnessio/backstage-plugin-ci-cd 共发布 22 个版本,首次发布于 2022/11/11;过去 12 个月发布了 1 个版本。

版本发布日期距今
1.0.0latest2026/09/092 个月前
0.11.02024/08/212 年前
0.10.02024/07/252 年前
0.9.02024/06/272 年前
0.8.02024/05/222 年前
0.6.02023/07/043 年前

关于 @harnessio/backstage-plugin-ci-cd 的常见问题

@harnessio/backstage-plugin-ci-cd 是什么?

后台的Harness CI/CD插件. 1.0.0目标后台 1.53 /回放 18. 对更老的后台使用0.11x.

如何安装 @harnessio/backstage-plugin-ci-cd?

在项目目录运行 npm install @harnessio/backstage-plugin-ci-cd,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0)、react-dom(^18.0.0)、react-router(^6.3.0)、react-router-dom(^6.3.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@harnessio/backstage-plugin-ci-cd 支持 TypeScript 吗?

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

@harnessio/backstage-plugin-ci-cd 支持 ESM 还是 CommonJS?

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

@harnessio/backstage-plugin-ci-cd 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js 22 || 24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@harnessio/backstage-plugin-ci-cd 可以商用吗?

@harnessio/backstage-plugin-ci-cd 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@harnessio/backstage-plugin-ci-cd 的下载量有多少?

根据 npm 官方下载统计,@harnessio/backstage-plugin-ci-cd 在 2026/10/18 – 2026/11/16 这 30 天内被下载 5,607 次,日均约 187 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@harnessio/backstage-plugin-ci-cd 还在维护吗?

最新版本 1.0.0 发布于 2026/09/09(2 个月前);至今共发布 22 个版本,其中过去 12 个月发布了 1 个;首次发布于 2022/11/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。