https://github.com/exuanbo/actions-deploy-gist

📌 Deploy file to Github Gist
https://github.com/exuanbo/actions-deploy-gist

actions deploy gist github-actions userscript

Last synced: 2 months ago
JSON representation

📌 Deploy file to Github Gist

• Host: GitHub
• URL: https://github.com/exuanbo/actions-deploy-gist
• Owner: exuanbo
• License: mit
• Created: 2020-09-10T07:58:26.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-17T13:19:18.000Z (9 months ago)
• Last Synced: 2024-10-06T19:10:01.592Z (3 months ago)
• Topics: actions, deploy, gist, github-actions, userscript
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/deploy-to-gist
• Size: 1.3 MB
• Stars: 37
• Watchers: 3
• Forks: 12
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Deploy to Gist

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/exuanbo/actions-deploy-gist.svg)](https://github.com/exuanbo/actions-deploy-gist/releases)

[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/exuanbo/actions-deploy-gist/test/main.svg?event=push)](https://github.com/exuanbo/actions-deploy-gist/actions?query=workflow%3Atest)

[![libera manifesto](https://img.shields.io/badge/libera-manifesto-lightgrey.svg)](https://liberamanifesto.com)

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

## Quick start

```yml

- uses: actions/checkout@v3

- name: Deploy

  uses: exuanbo/actions-deploy-gist@v1

  with:

    token: ${{ secrets.TOKEN }}

    gist_id: from_gist_url

    file_path: build/book.pdf

    file_type: binary

```

## Setup

### Prep work

1. Create a gist (public or secret) if you don't have one.

1. Generate a new [Personal access token](https://github.com/settings/tokens/). Only the `gist` scope is needed.

### Project setup

1. Go to the repo **Settings > Secrets**. Add the generated token with name `TOKEN`.

1. Edit workflow file `.github/workflows/deploy.yml` as the example above.

### Options

#### `token`

Personal access token for updating gist.

#### `gist_id`

Id portion from the gist url, e.g. `https://gist.github.com/exuanbo/`**`e885afa349a0e5d1cfb408e46d6a37bc`**.

#### `gist_description` (optional)

Description of the gist.

#### `gist_file_name` (optional)

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

#### `file_path`

Relative to the current repo's root directory, e.g. `dist/foo.bar`.

#### `file_type` (optional)

Default to `text`. It should be set to `binary` if the file is image, pdf, etc.

## License

[MIT License](https://github.com/exuanbo/actions-deploy-gist/blob/main/LICENSE) © 2021 [Exuanbo](https://github.com/exuanbo)