Skip to content

pentatonicfunk/action-gist-repo-sync

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Deploy to Gist

GitHub release (latest by date)

This is a GitHub Action to sync GitHub Repo to GitHub Gist.

Demos

Quick start

- name: Checkout
  uses: actions/checkout@v1
- name: Gist Repo Sync
  uses: pentatonicfunk/action-gist-repo-sync@v1
  with:
    gist_token: ${{ secrets.GIST_TOKEN }}
    gist_id: from_gist_url
    source_path: my_path

Setup

Prep work

  1. Create a gist (public or secret) if you don't have one.
  2. Generate a new Personal access token. Only the gist scope is needed.

Project setup

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

Options

gist_token

Personal access token for updating gist.

gist_id

ID portion from the gist url, e.g. https://gist.github.com/pentatonicfunk/867f66a0f25f9d4ca70adf1cf1944529.

source_path (optional)

Relative to the current repo's root directory, e.g. dist-docs. Default the repo directory it self ./

License

MIT License © pentatonicfunk