This GitHub Action creates a GitHub contribution calendar on a 3d profile image:
This action generate your github profile 3d contribute calendar and make a commit to your repo. You can also trigger action by yourself after add this action.
Create a repository on GitHub with the same name as your user name.
- e.g. If the user name is
romanutti, create a repository namedromanutti/romanutti. - ref. Managing your profile README
In this repository, do the following.
Create a workflow file like the one below.
.github/workflows/profile-3d.yml
The schedule is set to start once a day. Please correct the startup time to a convenient time.
name: GitHub-Profile-3D-Contrib
on:
schedule: # 03:00 JST == 18:00 UTC
- cron: "0 18 * * *"
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
name: generate-github-profile-3d-contrib
steps:
- uses: actions/checkout@v2
- uses: yoshi389111/github-profile-3d-contrib@0.2.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
USERNAME: ${{ github.repository_owner }}
- name: Commit & Push
run: |
git config user.name github-actions
git config user.email github-actions@github.com
git add -A .
git commit -m "generated"
git pushNote: If you also want to include the private repository, register the "personal access token" in the repository and set it to GITHUB_TOKEN specified in the workflow file.
This will add the action to the repository.
GITHUB_TOKEN: (required) access tokenUSERNAME: (required) target user name (or specify with an argument).MAX_REPOS: (optional) max repositories, default 100 - since ver. 0.2.0
Launch the added action.
Actions->GitHub-Profile-3D-Contrib->Run workflow
The profile image is generated with the following paths.
profile-3d-contrib/profile-green-animate.svgprofile-3d-contrib/profile-green.svgprofile-3d-contrib/profile-season-animate.svgprofile-3d-contrib/profile-season.svg
Add the path of the generated image to the readme file.
e.g.
MIT License