https://github.com/alexrogalskiy/github-action-user-contribution
👪 GitHub action for user contributions charts
https://github.com/alexrogalskiy/github-action-user-contribution
contributions github-actions
Last synced: 4 months ago
JSON representation
👪 GitHub action for user contributions charts
- Host: GitHub
- URL: https://github.com/alexrogalskiy/github-action-user-contribution
- Owner: AlexRogalskiy
- License: gpl-3.0
- Created: 2021-05-04T11:28:07.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-24T07:39:48.000Z (4 months ago)
- Last Synced: 2025-01-24T08:27:18.168Z (4 months ago)
- Topics: contributions, github-actions
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/user-contribution
- Size: 7.91 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 1,879
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/support.yml
- Authors: AUTHORS
Awesome Lists containing this project
README
# *GitHub user contribution charts*
> GitHub Action to provide GitHub user contribution charts
[](https://github.com/marketplace/actions/styled-user-contribution)
[](https://github.com/lekterable/perfekt)
[](https://github.com/prettier/prettier)
[](https://houndci.com)
[](https://github.com/AlexRogalskiy/github-action-user-contribution/discussions)
[](https://deepsource.io/gh/AlexRogalskiy/github-action-user-contribution/?ref=repository-badge)
[](https://deepscan.io/dashboard#view=project\&tid=11946\&pid=17041\&bid=375447)
[](https://renovatebot.com/)
[](https://dependabot.com/)
[](https://newreleases.io/github/AlexRogalskiy/github-action-user-contribution)
[](https://hitsofcode.com/github/alexrogalskiy/github-action-user-contribution?branch=master/view?branch=master)
[](https://david-dm.org/AlexRogalskiy/github-action-user-contribution)
[](https://david-dm.org/AlexRogalskiy/github-action-user-contribution?type=dev)
[](https://app.codeac.io/github/AlexRogalskiy/github-action-user-contribution)
[](https://coveralls.io/github/AlexRogalskiy/github-action-user-contribution?branch=master)
[](https://codebeat.co/projects/github-com-alexrogalskiy-github-action-user-contribution-master)
[](https://lgtm.com/projects/g/AlexRogalskiy/github-action-user-contribution/alerts/)
[](https://lgtm.com/projects/g/AlexRogalskiy/github-action-user-contribution/context:javascript)
[](https://codecov.io/gh/AlexRogalskiy/github-action-user-contribution)
[](https://github.com/AlexRogalskiy/github-action-user-contribution/actions/workflows/build.yml)
[](https://circleci.com/gh/AlexRogalskiy/github-action-user-contribution)
[](https://github.com/marketplace/actions/super-linter)
[](http://commitizen.github.io/cz-cli/)
[][repo]
[![Public workflows that use this action.][total_usages]][search_results]
[![License][license_id]][license_content]
[](https://github.com/AlexRogalskiy/github-action-user-contribution/discussions)
[](https://github.com/AlexRogalskiy/github-action-user-contribution/labels/question)
[](https://github.com/AlexRogalskiy/github-action-user-contribution/labels/bug)
## *Table of contents*
- [*Description*](#description)
- [*Inputs*](#inputs)
- [`userName`](#username)
- [`startDate`](#startdate)
- [`endDate`](#enddate)
- [`colorScheme`](#colorscheme)
- [`fileName`](#filename)
- [`filePath`](#filepath)
- [*Examples*](#examples)
- [Basic configuration](#basic-configuration)
- [Complete configuration](#complete-configuration)
- [*Visitor stats*](#visitor-stats)
- [*Licensing*](#licensing)
- [*Authors*](#authors)
- [*Versioning*](#versioning)
- [*Contribution*](#contribution)
- [*Acknowledgement*](#acknowledgement)
- [*Forks*](#forks)
- [*Development Support*](#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
```yaml
- name: Create GitHub user contribution chart
uses: alexrogalskiy/github-action-user-contribution@master
with:
userName: AlexRogalskiy
```
### Complete configuration
```yaml
- 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*
[](https://hits.seeyoufarm.com)
## *Licensing*
***File Size*** is distributed under LGPL version 3 or later, \[[License](https://github.com/AlexRogalskiy/github-action-user-contribution/blob/master/LICENSE)]
. LGPLv3 is additional permissions on top of GPLv3.
## *Authors*
***File Size*** is maintained by the following GitHub team-members:
- [](https://github.com/AlexRogalskiy)
with community support please contact with us if you have some question or proposition.
## *Versioning*
The project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository][tags].
## *Contribution*
[](https://badges.pufler.dev)
Please read
[contributing guide](https://github.com/AlexRogalskiy/github-action-user-contribution/blob/master/.github/CONTRIBUTING.md) or [wiki guide][wiki]
for details on our code of conduct, and the process for submitting pull requests to us
([emoji key](https://allcontributors.org/docs/en/emoji-key)).
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind are welcome!
[](http://makeapullrequest.com)
See also the list of [contributors page][contributors] who participated in this project.
## *Acknowledgement*
[][stars]
## *Forks*
[][forkers]
## *Development Support*
Like ***File Size*** ? Consider buying me a coffee :)
[](https://www.patreon.com/alexrogalskiy)
[](https://www.buymeacoffee.com/AlexRogalskiy)
[](https://ko-fi.com/alexrogalskiy)
***
[](https://www.typescriptlang.org/)
[](https://github.com/)
[](https://forthebadge.com/)
[repo]: https://github.com/AlexRogalskiy/github-action-user-contribution
[tags]: https://github.com/AlexRogalskiy/github-action-user-contribution/tags
[wiki]: https://github.com/AlexRogalskiy/github-action-user-contribution/wiki
[stars]: https://github.com/AlexRogalskiy/github-action-user-contribution/stargazers
[forkers]: https://github.com/AlexRogalskiy/github-action-user-contribution/network/members
[contributors]: https://github.com/AlexRogalskiy/github-action-user-contribution/graphs/contributors
[license_id]: https://img.shields.io/github/license/AlexRogalskiy/github-action-user-contribution
[license_content]: https://github.com/AlexRogalskiy/github-action-user-contribution/blob/master/LICENSE
[total_usages]: https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DAlexRogalskiy%2Fgithub-action-user-contribution%26badge%3Dtrue
[search_results]: https://github.com/search?o=desc&q=AlexRogalskiy/github-action-user-contribution+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code