Skip to content
This repository was archived by the owner on Jul 11, 2025. It is now read-only.

Commit af201e7

Browse files
Merge pull request #23 from open-AIMS/doc-build
Add documentation build process
2 parents bbab0ba + a7f0863 commit af201e7

File tree

5 files changed

+287
-471
lines changed

5 files changed

+287
-471
lines changed

.github/dependabot.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "monthly"
7+
open-pull-requests-limit: 99
8+
labels:
9+
- "dependencies"
10+
- "github-actions"

.github/workflows/Documenter.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Workflow for building and deploying a VitePress site to GitHub Pages
2+
name: Documenter
3+
4+
on:
5+
push:
6+
branches:
7+
- main
8+
tags: ['*']
9+
pull_request:
10+
11+
# Allows you to run this workflow manually from the Actions tab
12+
workflow_dispatch:
13+
14+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
15+
permissions:
16+
actions: write
17+
contents: write
18+
pages: write
19+
id-token: write
20+
statuses: write
21+
22+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
23+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
24+
concurrency:
25+
group: pages
26+
cancel-in-progress: false
27+
28+
jobs:
29+
# Build job
30+
build:
31+
runs-on: ubuntu-latest
32+
steps:
33+
- name: Checkout
34+
uses: actions/checkout@v4
35+
- name: Setup Julia
36+
uses: julia-actions/setup-julia@v2
37+
with:
38+
version: '1.10'
39+
- name: Pull Julia cache
40+
uses: julia-actions/cache@v2
41+
- name: Install documentation dependencies
42+
run: julia --project=docs -e 'using Pkg; pkg"dev ."; Pkg.instantiate(); Pkg.precompile(); Pkg.status()'
43+
#- name: Creating new mds from src
44+
- name: Build and deploy docs
45+
uses: julia-actions/julia-docdeploy@v1
46+
env:
47+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
48+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
49+
GKSwstype: "100" # for Plots.jl plots (if you have them)
50+
JULIA_DEBUG: "Documenter"
51+
DATADEPS_ALWAYS_ACCEPT: true

.github/workflows/TagBot.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: TagBot
2+
on:
3+
issue_comment:
4+
types:
5+
- created
6+
workflow_dispatch:
7+
jobs:
8+
TagBot:
9+
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: JuliaRegistries/TagBot@v1
13+
with:
14+
token: ${{ secrets.GITHUB_TOKEN }}
15+
ssh: ${{ secrets.DOCUMENTER_KEY }}

0 commit comments

Comments
 (0)