@lewisliu0717/npm-oidc-demo 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,41 +19,35 @@
|
|
|
19
19
|
|
|
20
20
|
1. 完成代码修改后,在本地运行 `npm version patch --no-git-tag-version`,同时更新 `package.json` 和 `package-lock.json` 的版本号。
|
|
21
21
|
2. 将代码和版本变更提交并推送到 `main`。
|
|
22
|
-
3. 打开 GitHub Actions → npm OIDC demo → Run workflow,选择 `main
|
|
22
|
+
3. 打开 GitHub Actions → npm OIDC demo → Run workflow,选择 `main`,再点击 Run workflow。
|
|
23
23
|
|
|
24
24
|
检查通过后,GitHub Actions 会自动打包并通过 OIDC 发布。每次使用新的版本号;已发布的版本号不能重复发布。
|
|
25
25
|
|
|
26
26
|
这套发布流程不需要在开发者电脑或 GitHub Secrets 中保存 npm 写权限 token,也不需要每 90 天更换发布 token。首次配置成功后,不需要为每次发布重复登录 npm 或重新配置 Trusted Publisher。
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## 谁可以发布
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
凡是拥有此仓库 Write(写入)或更高权限的人,都可以手动运行发布流程,无需其他人审批。组织成员身份本身不代表拥有此仓库的写权限;外部协作者如果拥有写权限,也可以运行此流程。
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
本例没有配置 GitHub Environment 或团队审批,npm Trusted Publisher 中的 Environment name 留空。通过仓库的访问权限管理发布人员,无需给每个人提供 npm 写权限 token。
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
## 工作流做什么
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
- 第二个任务只在 Actions 页面从 `main` 分支手动运行时执行;先通过 `check`,再根据 `dry_run` 选择预演或正式发布。
|
|
36
|
+
`.github/workflows/publish.yml` 对应 Actions 页面中的 `npm OIDC demo`,只有一个 `publish` 任务:
|
|
38
37
|
|
|
39
|
-
|
|
38
|
+
1. 仅接受手动运行,并检查选择的分支是否为 `main`;选择其他分支会跳过任务。
|
|
39
|
+
2. 获取点击运行时 `main` 对应的提交,准备 Node.js 24 和支持 OIDC 的 npm 11。
|
|
40
|
+
3. 安装依赖,执行 `npm run check`;检查失败时停止。
|
|
41
|
+
4. 执行 `npm publish`,由 npm 自动完成 OIDC 认证并发布 `package.json` 中的版本。
|
|
40
42
|
|
|
41
|
-
|
|
43
|
+
推送代码和创建或更新 PR 不会触发此工作流。同一时间只运行一个该工作流,避免并发发布。
|
|
42
44
|
|
|
43
|
-
|
|
44
|
-
2. 脚本读取并核对凭证中仓库、分支和工作流字段,不在日志或制品中保留完整 token,也不自行校验 JWT 签名。
|
|
45
|
-
3. 构建 `.tgz` 安装包,并在全新的目录中安装和调用它。
|
|
46
|
-
4. 将安装包保存为 GitHub Actions 制品,保留 1 天。
|
|
47
|
-
5. 跳过 `npm publish`。
|
|
48
|
-
|
|
49
|
-
这能够验证 GitHub 一侧的身份凭证和打包安装流程,**不能证明 npm 已信任此工作流或 npm 实际发布已经成功**。后两项仍需要 npm 包管理员完成 Trusted Publisher 授权。
|
|
50
|
-
|
|
51
|
-
发布工作流没有配置 `NPM_TOKEN` 或 `NODE_AUTH_TOKEN` 密钥,发布权限来自 npm 中预先配置的 Trusted Publisher。
|
|
45
|
+
发布工作流没有配置 `NPM_TOKEN` 或 `NODE_AUTH_TOKEN` 密钥,发布权限来自 npm 中预先配置的 Trusted Publisher。演示用的身份检查脚本、安装制品验证和制品上传步骤已移除。
|
|
52
46
|
|
|
53
47
|
## 首次跑通的顺序
|
|
54
48
|
|
|
55
49
|
1. 使用个人 npm 账号 `lewisliu0717`,测试包名称为 `@lewisliu0717/npm-oidc-demo`,可见性为公开。
|
|
56
|
-
2. 创建 GitHub
|
|
50
|
+
2. 创建 GitHub 仓库并推送代码和 `.github/workflows/publish.yml`。
|
|
57
51
|
3. 对全新的测试包,先由 npm 账号持有人登录并发布 `0.0.1`,创建 npm 包。
|
|
58
52
|
4. 在该 npm 包的 Settings → Trusted publishing 中添加 GitHub Actions:
|
|
59
53
|
- Organization or user:`LJHAAAAA`
|
|
@@ -62,7 +56,7 @@
|
|
|
62
56
|
- Environment name:留空,本案例没有配置 GitHub Environment。
|
|
63
57
|
- Allowed actions:允许直接执行 `npm publish`。
|
|
64
58
|
5. 把版本号更新为 `0.0.2`,推送到 `main`。
|
|
65
|
-
6. 打开 GitHub Actions → npm OIDC demo → Run workflow
|
|
59
|
+
6. 打开 GitHub Actions → npm OIDC demo → Run workflow,选择 `main`,执行 npm 发布。
|
|
66
60
|
7. 确认 Actions 发布成功,并从 npm 安装 `0.0.2` 验证。
|
|
67
61
|
|
|
68
62
|
新建 Trusted Publisher 后,需在 2 天内完成首次成功发布以验证配置;验证成功后无须按 90 天定期更换发布 token。
|