caspiano / actions-deploy-gist

📌 Deploy file to gist

Deploy to Gist

This is a Github Action to deploy your file to Github Gist.

Quick start

- uses: actions/checkout@v2
- name: Deploy
  uses: exuanbo/actions-deploy-gist@v1
  with:
    token: ${{ secrets.TOKEN }}
    gist_id: from_your_gist_url
    gist_file_name: foo.bar
    file_path: ./dist/foo.bar

Setup

Prep work

1. Create a public gist if you don't have one.
2. Generate a new Personal access token. Only the gist scope is needed. Check Scopes for OAuth Apps for details.

Project setup

1. Go to the repo Settings > Secrets. Add the generated token as TOKEN.
2. Edit workflow file .github/workflows/deploy.yml as the example above.

Options

gist_id

The id portion from your gist url, e.g. https://gist.github.com/exuanbo/e885afa349a0e5d1cfb408e46d6a37bc.

gist_file_name

Name of the file to be added in your gist. If not provided, the original file name from file_path will be used.

file_path

Relative to your repo's root directory, e.g. ./dist/foo.bar.

License

MIT