GitHub user contribution charts

GitHub Action to provide GitHub user contribution charts

Table of contents

• Description
• Inputs
  • userName
  • startDate
  • endDate
  • colorScheme
  • fileName
  • filePath
• Examples
  • Basic configuration
  • Complete configuration
• Visitor stats
• Licensing
• Authors
• Versioning
• Contribution
• Acknowledgement
• Forks
• Development Support

Description

Generates GitHub user contribution charts.

Inputs

userName

Required GitHub user name

startDate

Optional Start period date

endDate

Optional End period date

colorScheme

Optional Chart color scheme (default green)

fileName

Optional File name (default chart.svg)

filePath

Optional File path (default images)

Examples

Basic configuration

- name: Create GitHub user contribution chart
  uses: alexrogalskiy/github-action-user-contribution@master
  with:
    userName: AlexRogalskiy

Complete configuration

- name: Create GitHub user contribution chart
  uses: alexrogalskiy/github-action-user-contribution@master
  with:
    userName: 'AlexRogalskiy'
    startDate: '2017-12-03'
    endDate: '2018-12-03'
    colorScheme: 'green'
    fileName: 'chart.svg'
    filePath: 'images'

Running locally:

• npm run start:action --action github-action-user-contribution --userName AlexRogalskiy

Visitor stats

Licensing

File Size is distributed under LGPL version 3 or later, [License] . LGPLv3 is additional permissions on top of GPLv3.

Authors

File Size is maintained by the following GitHub team-members:

with community support please contact with us if you have some question or proposition.

Versioning

The project uses SemVer for versioning. For the versions available, see the tags on this repository.

Contribution

Please read contributing guide or wiki guide for details on our code of conduct, and the process for submitting pull requests to us (emoji key).

This project follows the all-contributors specification. Contributions of any kind are welcome!

See also the list of contributors page who participated in this project.

Acknowledgement

Forks

Development Support

Like File Size ? Consider buying me a coffee :)