Skip to content

Commit 31a4682

Browse files
Merge pull request #17 from ArnoStrouwen/CI
general CI improvements
2 parents b34a1b2 + fed1862 commit 31a4682

File tree

5 files changed

+87
-4
lines changed

5 files changed

+87
-4
lines changed

.github/workflows/CI.yml

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,33 @@
11
name: CI
22
on:
3-
push:
3+
pull_request:
44
branches:
55
- main
66
paths-ignore:
77
- 'docs/**'
8-
pull_request:
8+
push:
9+
branches:
10+
- main
911
paths-ignore:
1012
- 'docs/**'
13+
schedule:
14+
- cron: '44 4 * * 4'
1115
jobs:
1216
test:
1317
runs-on: ${{ matrix.os }}
18+
env:
19+
GROUP: ${{ matrix.group }}
1420
strategy:
1521
fail-fast: false
1622
matrix:
23+
group:
24+
- Core
1725
version:
1826
- '1'
1927
os:
2028
- ubuntu-latest
29+
- macos-latest
30+
- windows-latest
2131
steps:
2232
- uses: actions/checkout@v4
2333
- uses: julia-actions/setup-julia@v2
@@ -33,4 +43,4 @@ jobs:
3343
- uses: julia-actions/julia-processcoverage@v1
3444
- uses: codecov/codecov-action@v4
3545
with:
36-
files: lcov.info
46+
file: lcov.info

.github/workflows/Documentation.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ on:
55
- main
66
tags: '*'
77
pull_request:
8+
schedule:
9+
- cron: '44 4 * * 4'
810
jobs:
911
build:
1012
runs-on: ubuntu-latest

.github/workflows/Downgrade.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,33 @@
11
name: Downgrade
22
on:
33
pull_request:
4+
branches:
5+
- main
46
paths-ignore:
57
- 'docs/**'
68
push:
79
branches:
810
- main
911
paths-ignore:
1012
- 'docs/**'
13+
schedule:
14+
- cron: '44 4 * * 4'
1115
jobs:
1216
test:
1317
runs-on: ${{ matrix.os }}
18+
env:
19+
GROUP: ${{ matrix.group }}
1420
strategy:
1521
fail-fast: false
1622
matrix:
23+
group:
24+
- Core
1725
version:
1826
- '1'
1927
os:
2028
- ubuntu-latest
29+
- macos-latest
30+
- windows-latest
2131
steps:
2232
- uses: actions/checkout@v4
2333
- uses: julia-actions/setup-julia@v2
@@ -30,4 +40,4 @@ jobs:
3040
with:
3141
token: ${{ secrets.GITHUB_TOKEN }}
3242
- uses: julia-actions/julia-buildpkg@v1
33-
- uses: julia-actions/julia-runtest@v1
43+
- uses: julia-actions/julia-runtest@v1

docs/make.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
using UDEComponents
22
using Documenter
33

4+
cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
5+
cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
6+
47
DocMeta.setdocmeta!(UDEComponents, :DocTestSetup, :(using UDEComponents); recursive = true)
58

69
makedocs(;

docs/src/index.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,61 @@ Documentation for [UDEComponents](https://github.com/SebastianM-C/UDEComponents.
1212
```@autodocs
1313
Modules = [UDEComponents]
1414
```
15+
16+
## Reproducibility
17+
18+
```@raw html
19+
<details><summary>The documentation of this SciML package was built using these direct dependencies,</summary>
20+
```
21+
22+
```@example
23+
using Pkg # hide
24+
Pkg.status() # hide
25+
```
26+
27+
```@raw html
28+
</details>
29+
```
30+
31+
```@raw html
32+
<details><summary>and using this machine and Julia version.</summary>
33+
```
34+
35+
```@example
36+
using InteractiveUtils # hide
37+
versioninfo() # hide
38+
```
39+
40+
```@raw html
41+
</details>
42+
```
43+
44+
```@raw html
45+
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
46+
```
47+
48+
```@example
49+
using Pkg # hide
50+
Pkg.status(; mode = PKGMODE_MANIFEST) # hide
51+
```
52+
53+
```@raw html
54+
</details>
55+
```
56+
57+
```@eval
58+
using TOML
59+
using Markdown
60+
version = TOML.parse(read("../../Project.toml", String))["version"]
61+
name = TOML.parse(read("../../Project.toml", String))["name"]
62+
link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
63+
"/assets/Manifest.toml"
64+
link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
65+
"/assets/Project.toml"
66+
Markdown.parse("""You can also download the
67+
[manifest]($link_manifest)
68+
file and the
69+
[project]($link_project)
70+
file.
71+
""")
72+
```

0 commit comments

Comments
 (0)