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
Copy file name to clipboardExpand all lines: README.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,28 +23,32 @@ This is a Github Action to deploy your file to Github Gist.
23
23
24
24
### Prep work
25
25
26
-
1. Create a public gist if you don't have one.
26
+
1. Create a gist (public or secret) if you don't have one.
27
27
1. Generate a new [Personal access token](https://github.com/settings/tokens/). Only the `gist` scope is needed. Check [Scopes for OAuth Apps](https://docs.github.com/en/developers/apps/scopes-for-oauth-apps) for details.
28
28
29
29
### Project setup
30
30
31
-
1. Go to the repo **Settings > Secrets**. Add the generated token as `TOKEN`.
31
+
1. Go to the repo **Settings > Secrets**. Add the generated token with name `TOKEN`.
32
32
1. Edit workflow file `.github/workflows/deploy.yml` as the example above.
33
33
34
34
### Options
35
35
36
+
#### `token`
37
+
38
+
The personal access token for updating gist.
39
+
36
40
#### `gist_id`
37
41
38
42
The id portion from your gist url, e.g. `https://gist.github.com/exuanbo/`**`e885afa349a0e5d1cfb408e46d6a37bc`**.
39
43
40
-
#### `gist_file_name`
44
+
#### `gist_file_name` (optional)
41
45
42
-
Name of the file to be added in your gist. If not provided, the original file name from `file_path` will be used.
46
+
The name of the file to be added in your gist. If not provided, the original file name from `file_path` will be used.
43
47
44
48
#### `file_path`
45
49
46
50
Relative to your repo's root directory, e.g. `./dist/foo.bar`.
0 commit comments