Readme Credly Badges
一个自动更新 README 文件中 Credly 徽章详情的 Python GitHub Action。
用法
- 在仓库中创建一个
.github/workflows/
目录。 - 添加
update-badges.yaml
文件,内容如下:
yaml
name: Update Credly Badges
on:
schedule:
- cron: '0 0 * * *' # Runs daily at 00:00 UTC
workflow_dispatch: # Optional: allows manual trigger
permissions:
contents: write # Required if using the default GITHUB_TOKEN
jobs:
update-readme:
name: Update README with Credly Badges
runs-on: ubuntu-latest
steps:
- name: Update Badges in README
uses: jd-35656/readme-credly-badges@v1
with:
credly_username: 'your-credly-username'
github_token: ${{ secrets.GITHUB_TOKEN }}
- 在你的仓库中,创建或编辑
README.md
文件以包含:
markdown
## Credly Badges
<!-- START CREDLY BADGES -->
<!-- END CREDLY BADGES -->
参数
点击显示/关闭参数
名称 | 类型 | 必填 | 默认值 | 参数描述 | 更多描述 |
---|---|---|---|---|---|
credly_username | string | {github.actor} | 你的 Credly 用户名 | ||
badge_size | string | 150x150 | 徽章大小 (例如,150x150, 680x680) | ||
badge_sort_by | string | issued | 徽章排序方式 | 可选值:issued updated accepted 。 | |
github_api_url | string | https://api.github.com | GitHub API URL(用于 GitHub 企业版)。 | ||
github_token | string | true | {github.token} | 具有写入权限的令牌。 | |
github_repo | string | {github.repository} | 目标 GitHub 仓库。 | ||
github_branch | string | main | 目标文件所在的分支。 | ||
readme_file | string | README.md | 更新 markdown 文件的路径。 | ||
commit_message | string | Updated README with new badges | 自定义提交信息。 |
示例
markdown
### Credly 徽章
<!-- START CREDLY BADGES -->
[](https://www.credly.com/badges/9818630e-28f4-4541-964c-e79041c4d601)
[](https://www.credly.com/badges/d557a8cd-735a-4abe-8f83-0f2e4f514a2c)
[](https://www.credly.com/badges/06bb5e5a-8069-4d4d-9f39-d608dbf84cd3)
[](https://www.credly.com/badges/adfadf9c-8271-43d7-8edb-ae2370fe272d)
[](https://www.credly.com/badges/0def91c4-2a33-47a9-90fb-0cbaaaaca301)
[](https://www.credly.com/badges/8cdd9a26-4452-410d-9d20-b351629dcf75)
[](https://www.credly.com/badges/3ccfe59f-8525-4b35-bacb-d5955486bef4)
<!-- END CREDLY BADGES -->