Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
award

GitHub Action

Auto-add contributors

v0.0.2

Auto-add contributors

award

Auto-add contributors

Add contributors to your file automatically on schedule

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Auto-add contributors

uses: BobAnkh/add-contributors@v0.0.2

Learn more about this action in BobAnkh/add-contributors

Choose a version

add-contributors

A Github Action to add contributors to your markdown file(i.e. README.md) automatically on schedule

Specifically handle unreachable Chinese context

着重解决了中文内容乱码的问题

Now is under test

Usage

Create a workflow file such as .github/workflows/contributors.yml (you can find this workflow file in this repo)

name: Add contributors
on:
  schedule:
    - cron:  '20 20 * * *'

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'

Parameters

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

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

Maintainer

@BobAnkh

How to contribute

See CONTRIBUTING GUIDELINES for details

Contributors

BobAnkh/
BobAnkh

LICENSE

Apache-2.0 © BobAnkh