Skip to content

Commit 79b16e8

Browse files
committed
ci: update about release
1 parent f06eb8c commit 79b16e8

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

.github/workflows/build.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ jobs:
3636
if: github.event_name == 'push' # no pr
3737
needs: [build]
3838
runs-on: ubuntu-latest
39+
permissions:
40+
contents: write # 关键!允许创建 Release,无需 PAT
3941
steps:
4042
- name: Download all artifacts
4143
uses: actions/download-artifact@v4
@@ -51,11 +53,12 @@ jobs:
5153
if: startsWith(github.ref, 'refs/tags/')
5254
uses: ncipollo/release-action@v1
5355
with:
54-
token: ${{ secrets.Your_token_secrets_name }} # GitHub Token,不填报错: `Error: Error undefined: Parameter token or opts.auth is required`
56+
# token: ${{ secrets.Your_token_secrets_name }} # PAT GitHub Token。可选一,换成你的PAT,否则报错: `Error: Error undefined: Parameter token or opts.auth is required`
57+
token: ${{ secrets.GITHUB_TOKEN }} # 内置 Github Token。可选二
5558
name: 'Release ${{ github.ref_name }}'
5659
body: 'Release for tag ${{ github.ref_name }}'
5760
artifacts: |
58-
./dist/main.js
61+
./dist/plugin-build/main.js
5962
generateReleaseNotes: false # 自动根据 commits 生成 release notes。此外,这里应该导向一个更新日志页
6063
prerelease: ${{ endsWith(github.ref_name, 'beta') }} # 是否预发布
6164
makeLatest: ${{ !endsWith(github.ref_name, 'beta') }} # 是否最后一个版本

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ $ npm run build
1818

1919
将新插件开启后即可 (当前版本可能需要重启下插件/软件才可)
2020

21+
## 工作流使用
22+
23+
内置了 Github 工作流,帮你简化操作
24+
25+
- commit 到 github 中会自动完成编译,帮你进行代码错误检查
26+
- 如果 commit 中添加了版本标签 (不需要 `v` 开头),会自动帮你 Release
27+
- 如果版本标签以 `-beta` 结尾,将会自动发布一个非 Latest 的 Pre Release
28+
2129
## 从零生成此项目 (可选)
2230

2331
> [!note]
@@ -103,6 +111,9 @@ $ npm install -D any-menu
103111

104112
```bash
105113
# 然后是文件准备
114+
106115
# 创建和编写 `src/` 文件夹内的内容 (主要程序代码和样式文件)
107116
# 特殊:这里使用的特殊的方式将 css 文件转为字符串附加到 js 上,这样能方便你更好地利用代码着色功能编辑 js 文件
117+
118+
# 编写 .github/workflows 中的工作流 (可选)
108119
```

0 commit comments

Comments
 (0)