Skip to content

Commit 8c5c36f

Browse files
committed
Update CI.
1 parent 04b9299 commit 8c5c36f

File tree

5 files changed

+48
-41
lines changed

5 files changed

+48
-41
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,4 @@ assignees: ''
3030

3131
## Configuration
3232

33-
<!-- Which container image are you using? -->
34-
3533
<!-- What system are you using it on? -->

.github/ISSUE_TEMPLATE/software_request.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,6 @@ assignees: ''
1111

1212
<!-- What new package would you like in glotzerlab-software? -->
1313

14-
## Ubuntu package
15-
16-
<!-- What is the name of the ubuntu package? -->
17-
<!-- Search the `bionic` distribution https://packages.ubuntu.com/ -->
18-
1914
## Additional context
2015

2116
<!-- What additional information is helpful to understand this request? -->
22-
23-
## Developer
24-
25-
<!-- Who should add the software to the build scripts? -->
26-
<!-- Suggestion: You can contribute the changes as a PR: see `README.md` -->

.github/dependabot.yml

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,3 @@ updates:
2121
applies-to: security-updates
2222
patterns:
2323
- '*'
24-
- package-ecosystem: "pip"
25-
directory: "/doc"
26-
target-branch: trunk
27-
schedule:
28-
interval: "monthly"
29-
time: "07:00"
30-
timezone: "EST5EDT"
31-
pull-request-branch-name:
32-
separator: "-"
33-
open-pull-requests-limit: 2
34-
reviewers:
35-
- joaander
36-
groups:
37-
pip-version:
38-
applies-to: version-updates
39-
patterns:
40-
- '*'
41-
update-types:
42-
- minor
43-
- patch
44-
pip-security:
45-
applies-to: security-updates
46-
patterns:
47-
- '*'
48-
update-types:
49-
- minor
50-
- patch

.github/workflows/doc.yaml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: doc
2+
3+
concurrency:
4+
group: ${{ github.workflow }}-${{ github.ref }}
5+
cancel-in-progress: true
6+
7+
on:
8+
pull_request:
9+
push:
10+
branches:
11+
- "trunk"
12+
13+
workflow_dispatch:
14+
15+
defaults:
16+
run:
17+
shell: bash
18+
19+
env:
20+
CARGO_TERM_COLOR: always
21+
CLICOLOR: 1
22+
MDBOOK_VERSION: 0.4.37
23+
LINKCHECK_VERSION: 0.7.7
24+
25+
jobs:
26+
build_documentation:
27+
name: Build documentation
28+
runs-on: ubuntu-22.04
29+
steps:
30+
- uses: actions/checkout@v4.1.3
31+
- name: Install mdbook
32+
run: |
33+
mkdir -p "$HOME/.cargo/bin"
34+
curl -sSL "https://github.com/rust-lang/mdBook/releases/download/v$MDBOOK_VERSION/mdbook-v$MDBOOK_VERSION-x86_64-unknown-linux-gnu.tar.gz" | tar -xvz --directory "$HOME/.cargo/bin"
35+
- name: Install mdbook-linkcheck
36+
run: |
37+
curl -sSL "https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v$LINKCHECK_VERSION/mdbook-linkcheck.x86_64-unknown-linux-gnu.zip" -o mdbook-linkcheck.zip
38+
unzip mdbook-linkcheck.zip -d "$HOME/.cargo/bin"
39+
chmod a+x "$HOME/.cargo/bin/mdbook-linkcheck"
40+
- name: Add linkcheck configuration
41+
run: |
42+
echo -e "[output.linkcheck]\nfollow-web-links=true" >> doc/book.toml
43+
cat doc/book.toml
44+
- name: Build documentation
45+
run: mdbook build doc
46+
env:
47+
RUST_LOG: "mdbook=info,linkcheck=warn,reqwest=debug"

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,8 @@ build will contain the cluster name and a `gpu` or `cpu` suffix. For example:
5656
## Contributing
5757

5858
Contributions are welcomed via [pull requests]. Please report bugs and suggest feature
59-
enhancements via the [issue tracker]. See [ARCHITECTURE.md] for information on how the
59+
enhancements via the [issue tracker]. See `ARCHITECTURE.md` for information on how the
6060
repository is structured, including how to modify the containers.
6161

6262
[pull requests]: https://github.com/glotzerlab/software/pulls
6363
[issue tracker]: https://github.com/glotzerlab/software/issues
64-
[ARCHITECTURE.md]: ARCHITECTURE.md

0 commit comments

Comments
 (0)