herdstat-action

Warning herdstat-action is work in progress and neither feature complete nor tested thoroughly.

herdstat-action is a GitHub action for analyzing the community around open source projects. For more details see the herdstat repository

Inputs

Input	Description	Required	Default
version	The version of the herdstat CLI to use.	No	latest
configuration	The configuration file to use.	No	.herdstat.yaml

Usage

Configuration

Create a .herdstat.yaml file at the root of your repository with the following content

repositories:
  - <owner>/<repo>

This is a minimal configuration. For a full reference on all available options see the herdstat README and the .herdstat.reference.yaml.

Workflow

A sample workflow that generates a contribution graph daily at midnight and stores the resulting graph in the repository looks as follows:

on:
  schedule:
    # Runs every at midnight
    - cron: '0 0 * * *'
jobs:
  herdstat:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: herdstat/[email protected]
        with:
          version: v0.8.0
        env:
          GITHUB_TOKEN: ${{ secrets.HERDSTAT_PAT }}
      - uses: EndBug/add-and-commit@v9
        with:
          default_author: github_actions
          add: 'contribution-graph.svg'
          message: 'Update contribution graph'

Note that we provide a PAT to the action by means of the GITHUB_TOKEN environment variable to avoid rate limiting issues for unauthenticated API calls. The required scopes for the PAT are public_repo and read:org.

You can see that workflow in action in the herdstat/.github repository. The graph is included in the herdstat organization profile.

Note You can generate multiple contribution graphs in the same workflow by using multiple steps using the herdstat action each with a custom configuration file (using the configuration input parameter) with a different output filename (contribution-graph/filename property).