You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Auto-add contributors
v0.0.5
A Github Action to add contributors to your markdown file(i.e. README.md) automatically on schedule or triggered by events
Specifically handle unreachable Chinese context (着重解决了中文内容乱码的问题)
Feel free to submit a pull request or an issue, but make sure to follow the templates
Welcome contributors to improve this project together!
Create a workflow file such as .github/workflows/contributors.yml (you can find it in this repo)
name: Add contributors
on:
schedule:
- cron: '20 20 * * *'
# push:
# branches:
# - master
jobs:
add-contributors:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: BobAnkh/add-contributors@master
with:
REPO_NAME: 'BobAnkh/add-contributors'
CONTRIBUTOR: '### Contributors'
COLUMN_PER_ROW: '6'
ACCESS_TOKEN: ${{secrets.GITHUB_TOKEN}}
IMG_WIDTH: '100'
FONT_SIZE: '14'
PATH: '/README.md'
COMMIT_MESSAGE: 'docs(README): update contributors'
AVATAR_SHAPE: 'round'| Parameter | Description | Required | Default |
|---|---|---|---|
| REPO_NAME | Repository name | yes | - |
| CONTRIBUTOR | Where you want to add contributors list | no | ### Contributors |
| COLUMN_PER_ROW | Number of contributors per row | no | 6 |
| ACCESS_TOKEN | Github Access Token | yes | You can just pass ${{secrets.GITHUB_TOKEN}} |
| IMG_WIDTH | Width of img | no | 100 |
| FONT_SIZE | Font size of name (px) | no | 14 |
| PATH | Path to the file you want to add contributors' list | no | /README.md |
| COMMIT_MESSAGE | commit message | no | docs(README): update contributors |
| AVATAR_SHAPE | Set round for round avatar and square for square avatar |
no | square |
NOTE: You should leave a blank line after the
CONTRIBUTORline for the first timeNOTE: Github seems not support image style in markdown file rendering yet
You should follow our Code of Conduct
See CONTRIBUTING GUIDELINES for contributing conventions
BobAnkh |
Apache-2.0 © BobAnkh