Skip to content

Commit

Permalink
feat: add description for private repo (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
technote-space committed Sep 10, 2019
1 parent 73daa18 commit 57e32e5
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,24 @@ Just run [DocToc](https://github.com/thlorenz/doctoc) and commit to branch if ch
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

### For private repository
Use [actions/checkout](https://github.com/actions/checkout) to checkout before TOC Generator step.
e.g. `.github/workflows/toc.yml`
```yaml
on: push
name: TOC Generator
jobs:
assignAuthor:
name: TOC Generator
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: TOC Generator
uses: technote-space/toc-generator@v1
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

## Options
### TARGET_PATHS
Target file path. (Comma separated, [Detail](https://github.com/thlorenz/doctoc#adding-toc-to-individual-files))
Expand Down

0 comments on commit 57e32e5

Please sign in to comment.