Create contributors action

Github action for Create / Generate contributors list to your (README)

GitHub stars Usages

Versions

Stable Version GitHub Release GitHub Release

Introduction

Create contributors list. SVGs will in separate branch

Example

name: Generate contributors

on:
  schedule:
    - cron: '0 0 * * 1'
  pull_request:
    types: [ opened, synchronize, edited ]
  push:
    branches:
      - master
      - main
      - develop
      - feature/**
      - release/**
      - test/**
      - bugfix/**

jobs:
  generate-contributors:
    runs-on: ubuntu-latest
    steps:
      - name: Generate contributors
        uses: gouef/create-contributors-action@main
        with:
          excludeBot: false
          notGenerateContributorsMd: false
          commitMessageBot: "[Update] Automate update contributors"
          svgBranch: "contributors-svg"
        env:
          GITHUB_TOKEN: $

Action inputs

Input Default Required Description
branch main false Branch
excludeBot false true Exclude actions@github.com from contributors
botName GitHub Actions false Set bot name for contributors
botEmail actions@github.com false Set bot email address for contributors
notGenerateContributorsMd false true Not commit generated CONTRIBUTORS.md ?
commitMessageBot [Update] Automate update contributors true Commit message which bot will do
svgBranch contributors-svg true Branch where will save svgs of contributors

Contributors

JanGalek actions-user