@icebreakers/changelog-github 2.0.2 → 2.0.3
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 +8 -0
- package/README.zh.md +8 -0
- package/package.json +6 -5
package/README.md
CHANGED
|
@@ -21,6 +21,8 @@ pnpm add -D @changesets/cli @icebreakers/changelog-github
|
|
|
21
21
|
|
|
22
22
|
Point the Changesets config at the Icebreaker formatter and declare your repository slug:
|
|
23
23
|
|
|
24
|
+
`org/repo` is a placeholder; replace it with the GitHub repository that consumes this formatter.
|
|
25
|
+
|
|
24
26
|
```json
|
|
25
27
|
{
|
|
26
28
|
"changelog": [
|
|
@@ -74,3 +76,9 @@ Set `GITHUB_TOKEN` (or `GH_TOKEN`) with a token that can read public repo metada
|
|
|
74
76
|
- **Missing repo error** – ensure the tuple includes your `org/repo` string; the formatter throws early when it is absent.
|
|
75
77
|
- **Empty metadata** – verify the GitHub token is available to the process and that the commit/PR exists in the target repo.
|
|
76
78
|
- **Summary tags ignored** – tags must appear at the top of the summary, each on its own line, before the main description content.
|
|
79
|
+
|
|
80
|
+
## Project links
|
|
81
|
+
|
|
82
|
+
- Documentation: https://repoctl.icebreaker.top
|
|
83
|
+
- Repository: https://github.com/sonofmagic/repoctl/tree/main/packages/changelog-github
|
|
84
|
+
- Issues: https://github.com/sonofmagic/repoctl/issues
|
package/README.zh.md
CHANGED
|
@@ -19,6 +19,8 @@ pnpm add -D @changesets/cli @icebreakers/changelog-github
|
|
|
19
19
|
|
|
20
20
|
在 `.changeset/config.json` 中切换 changelog 生成器，并声明仓库地址：
|
|
21
21
|
|
|
22
|
+
`org/repo` 仅为占位符，请替换为实际使用此格式器的 GitHub 仓库。
|
|
23
|
+
|
|
22
24
|
```json
|
|
23
25
|
{
|
|
24
26
|
"changelog": [
|
|
@@ -72,3 +74,9 @@ author: @octocat
|
|
|
72
74
|
- **缺少 repo 报错**：确认元组里包含 `org/repo` 字符串，缺失时格式器会立即抛错。
|
|
73
75
|
- **元数据为空**：检查 GitHub Token 是否生效，以及提交 / PR 是否存在于对应仓库。
|
|
74
76
|
- **摘要指令未生效**：指令需要放在摘要最顶部，并且每行单独书写；正文内容必须位于指令之后。
|
|
77
|
+
|
|
78
|
+
## 项目链接
|
|
79
|
+
|
|
80
|
+
- 文档：https://repoctl.icebreaker.top
|
|
81
|
+
- 仓库：https://github.com/sonofmagic/repoctl/tree/main/packages/changelog-github
|
|
82
|
+
- 问题反馈：https://github.com/sonofmagic/repoctl/issues
|
package/package.json
CHANGED
|
@@ -1,22 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@icebreakers/changelog-github",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "2.0.
|
|
5
|
-
"description": "Changesets GitHub changelog formatter for
|
|
4
|
+
"version": "2.0.3",
|
|
5
|
+
"description": "Changesets GitHub changelog formatter for the repoctl development toolchain",
|
|
6
6
|
"author": "ice breaker <1324318532@qq.com>",
|
|
7
7
|
"license": "MIT",
|
|
8
|
+
"homepage": "https://repoctl.icebreaker.top",
|
|
8
9
|
"repository": {
|
|
9
10
|
"type": "git",
|
|
10
|
-
"url": "git+https://github.com/sonofmagic/
|
|
11
|
+
"url": "git+https://github.com/sonofmagic/repoctl.git",
|
|
11
12
|
"directory": "packages/changelog-github"
|
|
12
13
|
},
|
|
13
14
|
"bugs": {
|
|
14
|
-
"url": "https://github.com/sonofmagic/
|
|
15
|
+
"url": "https://github.com/sonofmagic/repoctl/issues"
|
|
15
16
|
},
|
|
16
17
|
"keywords": [
|
|
17
18
|
"changesets",
|
|
18
19
|
"changelog",
|
|
19
|
-
"
|
|
20
|
+
"repoctl",
|
|
20
21
|
"icebreakers"
|
|
21
22
|
],
|
|
22
23
|
"sideEffects": false,
|