-
Notifications
You must be signed in to change notification settings - Fork 0
57 lines (51 loc) · 1.9 KB
/
docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# This workflow runs whenever a PR is opened or updated, or a commit is pushed to main. It runs
# several checks:
# - fmt: checks that the code is formatted according to rustfmt
# - clippy: checks that the code does not contain any clippy warnings
# - doc: checks that the code can be documented without errors
# - hack: check combinations of feature flags
# - msrv: check that the msrv specified in the crate is correct
name: check-docs
permissions:
contents: read
# This configuration allows maintainers of this repo to create a branch and pull request based on
# the new branch. Restricting the push trigger to the main branch ensures that the PR only gets
# built once.
on:
push:
branches: [ main ]
pull_request:
# If new code is pushed to a PR branch, then cancel in progress workflows for that PR. Ensures that
# we don't waste CI time, and returns results quicker https://github.com/jonhoo/rust-ci-conf/pull/5
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
jobs:
markdownlint:
runs-on: ubuntu-latest
name: Check with markdownlint
steps:
- name: Checkout source
uses: actions/checkout@v4
- name: Install Just
uses: extractions/setup-just@v2
- name: Install requirements (pip, npm, apt)
run: |
just docs-install-requirements
npm install --global typedoc
- name: markdownlint
run: just markdownlint
build-docs:
runs-on: ubuntu-latest
name: Build Docs
steps:
- name: Checkout source
uses: actions/checkout@v4
- name: Install Just
uses: extractions/setup-just@v2
- name: Install requirements (pip, npm, apt)
run: |
just docs-install-requirements
npm install --global typedoc
- name: Build docs
run: just docs-build