You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/exuanbo/actions-deploy-gist/actions?query=workflow%3Atest)
4
4
5
-
## Getting started
5
+
## Quick start
6
6
7
7
```yml
8
+
- uses: actions/checkout@v2
8
9
- name: Deploy
9
10
uses: exuanbo/actions-deploy-gist@v1
10
11
with:
11
12
token: ${{ secrets.TOKEN }}
12
-
gist_id: if_you_don't_have_then_create_one
13
+
gist_id: from_your_gist_url
13
14
gist_file_name: foo.bar
14
15
file_path: ./dist/foo.bar
15
16
```
16
17
18
+
## Setup
19
+
20
+
### Prep work
21
+
22
+
1. Create a public gist if you don't have one.
23
+
1. Generate a new [Personal access token](https://github.com/settings/tokens/). Only the `gist` scope is needed.
24
+
25
+
Check [Scopes for OAuth Apps](https://docs.github.com/en/developers/apps/scopes-for-oauth-apps) for details.
26
+
27
+
### Project setup
28
+
29
+
1. Edit your repo `.github/workflows/foo.yml`.
30
+
1. Go to your repo **Settings > Secrets**. Add the token generated above as `TOKEN`.
31
+
32
+
### Options
33
+
34
+
- `token`: `${{ secrets.TOKEN }}`
35
+
- `gist_id`: The id portion from your gist url, e.g. `https://gist.github.com/exuanbo/`**`e885afa349a0e5d1cfb408e46d6a37bc`**.
36
+
- `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.
0 commit comments