Skip to content

Commit

Permalink
Simplify the key setup instructions (#21)
Browse files Browse the repository at this point in the history
* Simplify the key setup instructions

* Set `permissions: contents: write`
  • Loading branch information
rikhuijzer authored May 26, 2022
1 parent 7fe24b8 commit 80c0bdc
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ on:

jobs:
Documenter:
permissions:
contents: write
name: Documentation
runs-on: ubuntu-latest
steps:
Expand All @@ -19,13 +21,6 @@ jobs:
- uses: julia-actions/julia-docdeploy@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
```
You need `DOCUMENTER_KEY` for deployement, which you can generate using DocumenterTools:
```
julia> using DocumenterTools, YourPackage
julia> DocumenterTools.genkeys(YourPackage)
```
If you need to build your documentation on a particular Julia version, you can insert
Expand Down

0 comments on commit 80c0bdc

Please sign in to comment.