action.yml

name: "generate-snake-game-from-github-contribution-grid-extended"
description: "Generates a snake game from a github user contributions grid. Output the animation as gif or svg"
author: "Arthurlobopro"

runs:
  using: docker
  image: docker://arthurlobo/snk@sha256:e6ce52d361c6673fa860f5af70bcb36c27909429faeea7795a10cfc54d29a244

inputs:
  github_user_name:
    description: "github user name"
    required: true
  github_token:
    description: "github token used to fetch the contribution calendar. Default to the action token if empty."
    required: false
    default: ${{ github.token }}
  outputs:
    required: false
    description: |
      list of files to generate.
      one file per line. Each output can be customized with options as query string.

       supported query string options:

      - palette:      A preset of color, one of [github, github-dark, github-light]
      - color_snake:  Color of the snake
      - color_dots:   Coma separated list of dots color. 
                      The first one is 0 contribution, then it goes from the low contribution to the highest.
                      Exactly 5 colors are expected.
      - hide_stack: If should hide progressbar, by default is false
      - dot_shape: The shape of the contribution dots, 
                   must be one of [square, square-rounded, circle]. 
                   By default is square-rounded.
      - speed: The speed of animation, must be one of [fast, normal, slow].
               By default is normal
      - snake_size: The size of the snake, must be a number between 1 and 6.
                    By default is 4.

      example:
        outputs: |
          dark.svg?palette=github-dark&color_snake=blue&hide_stack=true
          light.svg?color_snake=#7845ab
          ocean.gif?color_snake=orange&color_dots=#bfd6f6,#8dbdff,#64a1f4,#4b91f1,#3c7dd9