docs: 初始化仓库 README 和 .gitignore
This commit is contained in:
@@ -0,0 +1,5 @@
|
||||
.DS_Store
|
||||
*.swp
|
||||
*.bak
|
||||
.idea/
|
||||
.vscode/
|
||||
@@ -0,0 +1,38 @@
|
||||
# gitea_admin/ci-actions
|
||||
|
||||
Gitea Actions 公共 action 仓库。
|
||||
|
||||
通过 `uses: gitea_admin/ci-actions/<name>@v1` 在业务 workflow 中复用,
|
||||
避免每个仓库重复实现。
|
||||
|
||||
## 可用 action
|
||||
|
||||
| Action | 用途 |
|
||||
|---|---|
|
||||
| [`notify-bark/`](./notify-bark/) | 推送结果到 Bark iOS 客户端 |
|
||||
| [`notify-email/`](./notify-email/) | 发送结果邮件(兼容 163/126 SMTP) |
|
||||
|
||||
## 引用示例
|
||||
|
||||
```yaml
|
||||
- uses: gitea_admin/ci-actions/notify-bark@v1
|
||||
with:
|
||||
device_key: ${{ secrets.BARK_DEVICE_KEY }}
|
||||
title: "[${{ github.repository }}] ${{ github.workflow }}"
|
||||
body: "status: ${{ needs.build.result }}"
|
||||
```
|
||||
|
||||
完整示例见各 action 的 README。
|
||||
|
||||
## 版本约定
|
||||
|
||||
- 首次发布打 `v1.0.0`;业务 workflow 用 `@v1`(永远指向 `v1.x.y` 最新)
|
||||
- 改 bug → `v1.0.1`;兼容新 input → `v1.1.0`;breaking change → `v2.0.0`
|
||||
|
||||
## 添加新 action
|
||||
|
||||
1. 在仓库根下新建 `<action-name>/` 目录
|
||||
2. 写 `action.yml`(composite / docker 形态)
|
||||
3. 写 `README.md` 说明 inputs / outputs / 使用示例
|
||||
4. 在本 README 的「可用 action」表格里加一行
|
||||
5. 提交后打 tag `v1.x.y`
|
||||
Reference in New Issue
Block a user