Skip to content

Commit a71a1e8

Browse files
author
Amelia Wattenbeger
committed
require github_token
1 parent 9a2933a commit a71a1e8

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ A GitHub Action that creates an SVG diagram of your repo.
44

55
## Inputs
66

7+
## `github_token` **required**
8+
9+
We need your GitHub token to update the diagram. Specify it like:
10+
`github_token: ${{ secrets.GITHUB_TOKEN }}`
11+
712
## `output_file`
813

914
A path (relative to the root of your repo) to where you would like the diagram to live. For example: images/diagram.svg. Default: diagram.svg

action.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ inputs:
55
output_file:
66
description: "A path (relative to the root of your repo) to where you would like the diagram to live. For example: images/diagram.svg. Default: diagram.svg"
77
required: false
8+
github_token:
9+
description: "We need your GitHub token to update the diagram. Specify it like: with: github_token: ${{ secrets.GITHUB_TOKEN }}"
10+
required: true
811
runs:
912
using: "node12"
1013
main: "index.js"

0 commit comments

Comments
 (0)