1- # GitHub Action for generating a contribution graph with a snake eating your contributions.
2-
3- name : Generate Snake
4-
5- # Controls when the action will run. This action runs every 6 hours.
1+ name : generate animation
62
73on :
4+ # run automatically every 24 hours
85 schedule :
9- # every 6 hours
10- - cron : " 0 */6 * * *"
11-
12- # This command allows us to run the Action automatically from the Actions tab.
6+ - cron : " 0 */12 * * *"
7+
8+ # allows to manually run the job at any time
139 workflow_dispatch :
10+
11+ # run on every push on the master branch
12+ push :
13+ branches :
14+ - master
15+
16+
1417
15- # The sequence of runs in this workflow:
1618jobs :
17- # This workflow contains a single job called "build"
18- build :
19- # The type of runner that the job will run on
19+ generate :
20+ permissions :
21+ contents : write
2022 runs-on : ubuntu-latest
21-
22- # Steps represent a sequence of tasks that will be executed as part of the job
23+ timeout-minutes : 5
24+
2325 steps :
24-
25- # Checks repo under $GITHUB_WORKSHOP, so your job can access it
26- - uses : actions/checkout@v2
27-
28- # Generates the snake
29- - uses : Platane/snk@master
30- id : snake-gif
26+ # generates a snake game from a github user (<github_user_name>) contributions graph, output a svg animation at <svg_out_path>
27+ - name : generate github-contribution-grid-snake.svg
28+ uses : Platane/snk/svg-only@v3
3129 with :
32- github_user_name : pythonicforge
33- # these next 2 lines generate the files on a branch called "output". This keeps the main branch from cluttering up.
34- gif_out_path : dist/github-contribution-grid-snake.gif
35- svg_out_path : dist/github-contribution-grid-snake.svg
36-
37- # show the status of the build. Makes it easier for debugging (if there's any issues).
38- - run : git status
39-
40- # Push the changes
41- - name : Push changes
42- uses : ad-m/github-push-action@master
43- with :
44- github_token : ${{ secrets.GITHUB_TOKEN }}
45- branch : master
46- force : true
47-
48- -
uses :
crazy-max/[email protected] 30+ github_user_name : ${{ github.repository_owner }}
31+ outputs : |
32+ dist/github-contribution-grid-snake.svg
33+ dist/github-contribution-grid-snake-dark.svg?palette=github-dark
34+
35+
36+ # push the content of <build_dir> to a branch
37+ # the content will be available at https://raw.githubusercontent.com/<github_user>/<repository>/<target_branch>/<file> , or as github page
38+ - name : push github-contribution-grid-snake.svg to the output branch
39+ 4940 with :
50- # the output branch we mentioned above
5141 target_branch : output
5242 build_dir : dist
5343 env :
54- GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
44+ GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
0 commit comments