Skip to content

Commit 96768f1

Browse files
authored
Update workflows for doc deployment (#509)
Updates to re-enable documentation deployment and TagBot functionality.
1 parent 54cdf52 commit 96768f1

File tree

2 files changed

+32
-19
lines changed

2 files changed

+32
-19
lines changed

.github/workflows/TagBot.yml

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,14 @@ on:
66
workflow_dispatch:
77
inputs:
88
lookback:
9-
default: 3
10-
permissions:
11-
actions: read
12-
checks: read
13-
contents: write
14-
deployments: read
15-
issues: read
16-
discussions: read
17-
packages: read
18-
pages: read
19-
pull-requests: read
20-
repository-projects: read
21-
security-events: read
22-
statuses: read
9+
default: 5
2310
jobs:
2411
TagBot:
12+
permissions:
13+
actions: write
14+
contents: write
15+
pull-requests: write
16+
statuses: write
2517
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
2618
runs-on: ubuntu-latest
2719
steps:

.github/workflows/deploy_docs.yml

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
name: Documenter
22
on:
33
push:
4-
branches: [master]
4+
branches:
5+
- master
56
tags: [v*]
67
pull_request:
78
workflow_dispatch:
@@ -12,11 +13,31 @@ concurrency:
1213

1314
jobs:
1415
docdeploy:
16+
# These permissions are needed to:
17+
# - Deploy the documentation: https://documenter.juliadocs.org/stable/man/hosting/#Permissions
18+
# - Delete old caches: https://github.com/julia-actions/cache#usage
19+
permissions:
20+
actions: write
21+
contents: write
22+
pull-requests: read
23+
statuses: write
1524
runs-on: ubuntu-latest
1625
steps:
1726
- uses: actions/checkout@v4
18-
- uses: julia-actions/julia-buildpkg@latest
19-
- uses: julia-actions/julia-docdeploy@latest
27+
- uses: julia-actions/setup-julia@v2
28+
with:
29+
version: '1'
30+
show-versioninfo: true # versioninfo will be printed to the action log
31+
- uses: julia-actions/cache@v2
32+
# - uses: julia-actions/julia-buildpkg@v1 # if package requires Pkg.build()
33+
- name: Install dependencies
34+
shell: julia --color=yes --project=docs {0}
35+
run: |
36+
using Pkg
37+
Pkg.develop(PackageSpec(path=pwd()))
38+
Pkg.instantiate()
39+
- name: Build and deploy
40+
run: julia --color=yes --project=docs docs/make.jl
2041
env:
21-
DOCUMENTER_KEY: ${{ secrets.COMPATHELPER_PRIV }}
22-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
43+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key

0 commit comments

Comments
 (0)