Skip to content

Gitartwork on user's contribution graph

Latest
Compare
Choose a tag to compare
@jasineri jasineri released this 15 Jul 11:26
· 337 commits to main since this release

gitartwork on user's contribution graph

gitartwork on user's contribution graph, make a SVG image of it and finally push it back to your repository.

An example result:
jasineri/gitartwork

Usage:

Option #1: Use gitartwork as a GitHub Action

  1. Ensure that under Settings > Actions > General > Workflow permissions, the "Read and write permissions" is set!

  2. Copy the workflow code into a .github/workflows/gitartwork.yml file in your repository.

     name: gitartwork from a contribution graph
     on: 
       push:
       schedule:
         - cron: '* */24 * * *'
     jobs:
       build:
         name: Make gitartwork SVG
         runs-on: ubuntu-latest
         steps:
           - uses: actions/checkout@v3
           - uses: jasineri/gitartwork@v1
             with:
                # Use this username's contribution graph  
                user_name: jasineri
                # Text on contribution graph 
                text: JASINERI
           - uses: jasineri/simple-push-action@v1
    
  3. A few moments later it will generate gitartwork.svg image in your repository, so then you can include it in your README.md like ![gitartwork](gitartwork.svg)

  4. Have fun :)

Troubleshooting

  1. If your gitartwork's image is missing and the action workflow ends with an error message stating "Permission to ... denied to github-actions[bot]", check the workflow permissions settings (see "Usage" above).

Option #2: Make gitartwork locally on your environment

Still in progress...