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

GitHub Action

GitHub Stats Analyser

v1.0.0

GitHub Stats Analyser

code

GitHub Stats Analyser

Analyse GitHub and generate statistics for a user's repositories

Installation

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

 
              
- name: GitHub Stats Analyser

              
  uses: JackPlowman/[email protected]
Learn more about this action in JackPlowman/github-stats-analyser

Choose a version

GitHub Stats Analyser

Table of Contents

Introduction

This project is a tool to analyse the statistics of a user's GitHub repositories.

It is designed to be used as a GitHub Action.

The tool is written in Python and uses the GitHub API to some of the statistics. As well it clones the repositories to be analysed and analyses the files in the repositories.

Usage

GitHub Action Example

The GitHub Action is designed to be used in a workflow.

- name: Analyse GitHub repositories
  uses: jackplowman/github-stats-analyser@latest
  with:
    repository_owner: jackplowman # Put your GitHub username here or use ${{ github.repository_owner }}

GitHub Action Inputs

Name Required Description Type Default
repository_owner yes The GitHub username of the repositories to analyse. string N/A
github-token no A GitHub token to authenticate API requests. string ${{ github.token }}