Skip to content

BobAnkh/add-contributors

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

add-contributors

Codacy Badge GitHub release (latest by date) language-python LICENSE Apache-2.0

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!

Usage

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:
        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'

Parameters

Parameter Description Required Default
REPO_NAME Repository name no '' which means current repository
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
BRANCH The branch to update file specified in PATH no '' which means default branch
PULL_REQUEST Open a new pull request if set to a target branch name no '' which means not open pull request by default
COMMIT_MESSAGE commit message no docs(README): update contributors
AVATAR_SHAPE Set round for round avatar and square for square avatar no square
IGNORED_CONTRIBUTORS Ignored contributors, seperated by comma no ''

NOTE: You should leave a blank line after the CONTRIBUTOR line for the first time

NOTE: Github seems not support image style in markdown file rendering yet

NOTE: IGNORED_CONTRIBUTORS takes display name not username

NOTE: PULL_REQUEST must be used with BRANCH together, both should be provided if you want to open a pull request

Maintainer

@BobAnkh

How to contribute

You should follow our Code of Conduct.

See CONTRIBUTING GUIDELINES for contributing conventions.

Make sure to pass all the tests before submitting your code. You can conduct pytest -ra at the root directory to run all tests.

You can use local mode when develope it on your local machine, here is the command-line help info:

usage: main.py [-h] [-m MODE] [-f FILE] [-o OUTPUT] [-t TOKEN]

optional arguments:
  -h, --help            show this help message and exit
  -m MODE, --mode MODE  choose to use local-dev mode or on github action mode.
                        Valid values are 'local' or 'github'
  -f FILE, --file FILE  configuration file to read from when running local-dev
                        mode
  -o OUTPUT, --output OUTPUT
                        output file when running local-dev mode
  -t TOKEN, --token TOKEN
                        Github Access Token

Contributors

Yixin
Yixin Shen
Bailey
Bailey Harrington
Casper/
Casper

LICENSE

Apache-2.0 © BobAnkh