|
| 1 | +GitHub Action for generating a contribution graph with a snake eating your contributions. |
| 2 | + |
1 | 3 | name: Generate Snake |
2 | 4 |
|
| 5 | +# Controls when the action will run. This action runs every 6 hours. |
| 6 | + |
3 | 7 | on: |
4 | 8 | schedule: |
5 | | - - cron: "0 0 * * *" # Runs daily at midnight UTC |
| 9 | + # every 6 hours |
| 10 | + - cron: "0 */6 * * *" |
| 11 | + |
| 12 | +# This command allows us to run the Action automatically from the Actions tab. |
6 | 13 | workflow_dispatch: |
7 | 14 |
|
| 15 | +# The sequence of runs in this workflow: |
8 | 16 | jobs: |
| 17 | + # This workflow contains a single job called "build" |
9 | 18 | build: |
| 19 | + # The type of runner that the job will run on |
10 | 20 | runs-on: ubuntu-latest |
11 | 21 |
|
| 22 | + # Steps represent a sequence of tasks that will be executed as part of the job |
12 | 23 | steps: |
13 | | - - name: Checkout repository |
14 | | - uses: actions/checkout@v2 |
15 | 24 |
|
16 | | - - name: Generate Snake Animation |
17 | | - uses: Platane/snk@v3 |
| 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 |
| 31 | + with: |
| 32 | + github_user_name: nurulshaikh786 |
| 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 |
18 | 43 | with: |
19 | | - github_user_name: ${{ github.repository_owner }} |
20 | | - outputs: | |
21 | | - dist/github-contribution-grid-snake.svg |
22 | | - dist/github-contribution-grid-snake-dark.svg?palette=github-dark |
| 44 | + github_token: ${{ secrets.GITHUB_TOKEN }} |
| 45 | + branch: master |
| 46 | + force: true |
23 | 47 |
|
24 | | - - name: Push Snake Animation to Output Branch |
25 | | - |
| 48 | + - uses: crazy-max/[email protected] |
26 | 49 | with: |
| 50 | + # the output branch we mentioned above |
27 | 51 | target_branch: output |
28 | 52 | build_dir: dist |
29 | 53 | env: |
|
0 commit comments