https://github.com/cfug/dio_issue_release_action
https://github.com/cfug/dio_issue_release_action
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/cfug/dio_issue_release_action
- Owner: cfug
- License: apache-2.0
- Created: 2023-02-21T09:04:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T03:22:30.000Z (about 2 years ago)
- Last Synced: 2024-06-18T03:44:47.265Z (about 2 years ago)
- Language: Dart
- Size: 2.72 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# For cfug/dio package action
功能：根据评论自动发布版本
v2 使用 **dart 重写**
action 配置
```yml
jobs:
auto_release_with_comment:
if: github.event.issue.number == 3 # Set it for specific issue number
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
token: ${{ secrets.GITHUB_TOKEN }}
- uses: dart-lang/setup-dart@v1.3
- name: auto release with comment
uses: cfug/dio_issue_release_action@v2
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
pub-credentials-json: ${{ secrets.PUB_CREDENTIALS_JSON }}
```
| 参数 | 说明 |
| -------------------- | ------------------------------------------------------------------------------------ |
| github-token | 用于在项目中调取 github api 来检查权限等操作 |
| pub-credentials-json | 用于执行 pub publish 的一些操作，需要在 github 项目的 secrets 中设置 |
| do-publish | 是否执行 publish to pub.dev |
| do-release | 是否执行 git push && create github release |
## 权限
因为 action 在使用时，涉及到修改项目文件并提交，所以需要有写入的权限。
## 做的事
1. 检查 issue 评论者是否有写入权限
1. 检查评论内容是否为 `dio: v1.0.0` 这样的格式
1. 目前评论内容支持多行，也就是同时提交多个包，这里是有顺序的，所以如果有依赖关系，需要先发布依赖的包
1. 检查包是否是 `dio` 或几个 plugin 之一
1. 根据包的类型配置判断是安装 dart 还是 flutter 库
1. 修改前先执行一次 publish 的 dry-run 操作
1. 修改对应包的 `pubspec.yaml` 文件中的 `version` 字段
1. 修改 CHANGELOG.md 文件，并把 unrelease 的内容移动到新的版本中
1. 执行 git add, git commit, git push
1. 在 main 分支上打 release tag
1. 发布到 pub.dev