Merge pull request #17 from ArnoStrouwen/CI

general CI improvements

.github/workflows/CI.yml

@@ -1,23 +1,33 @@
 name: CI
 on:
-  push:
+  pull_request:
     branches:
       - main
     paths-ignore:
       - 'docs/**'
-  pull_request:
+  push:
+    branches:
+      - main
     paths-ignore:
       - 'docs/**'
+  schedule:
+    - cron: '44 4 * * 4'
 jobs:
   test:
     runs-on: ${{ matrix.os }}
+    env:
+      GROUP: ${{ matrix.group }}
     strategy:
       fail-fast: false
       matrix:
+        group:
+          - Core
         version:
           - '1'
         os:
           - ubuntu-latest
+          - macos-latest
+          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
@@ -33,4 +43,4 @@ jobs:
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v4
         with:
-          files: lcov.info
+          file: lcov.info

.github/workflows/Documentation.yml

@@ -5,6 +5,8 @@ on:
       - main
     tags: '*'
   pull_request:
+  schedule:
+    - cron: '44 4 * * 4'
 jobs:
   build:
     runs-on: ubuntu-latest

.github/workflows/Downgrade.yml

@@ -1,23 +1,33 @@
 name: Downgrade
 on:
   pull_request:
+    branches:
+      - main
     paths-ignore:
       - 'docs/**'
   push:
     branches:
       - main
     paths-ignore:
       - 'docs/**'
+  schedule:
+    - cron: '44 4 * * 4'
 jobs:
   test:
     runs-on: ${{ matrix.os }}
+    env:
+      GROUP: ${{ matrix.group }}    
     strategy:
       fail-fast: false
       matrix:
+        group:
+          - Core
         version:
           - '1'
         os:
           - ubuntu-latest
+          - macos-latest
+          - windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
@@ -30,4 +40,4 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
       - uses: julia-actions/julia-buildpkg@v1
-      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-runtest@v1

docs/make.jl

@@ -1,6 +1,9 @@
 using UDEComponents
 using Documenter
 
+cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
+cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
+
 DocMeta.setdocmeta!(UDEComponents, :DocTestSetup, :(using UDEComponents); recursive = true)
 
 makedocs(;

docs/src/index.md

@@ -12,3 +12,61 @@ Documentation for [UDEComponents](https://github.com/SebastianM-C/UDEComponents.
 ```@autodocs
 Modules = [UDEComponents]
 ```
+
+## Reproducibility
+
+```@raw html
+<details><summary>The documentation of this SciML package was built using these direct dependencies,</summary>
+```
+
+```@example
+using Pkg # hide
+Pkg.status() # hide
+```
+
+```@raw html
+</details>
+```
+
+```@raw html
+<details><summary>and using this machine and Julia version.</summary>
+```
+
+```@example
+using InteractiveUtils # hide
+versioninfo() # hide
+```
+
+```@raw html
+</details>
+```
+
+```@raw html
+<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
+```
+
+```@example
+using Pkg # hide
+Pkg.status(; mode = PKGMODE_MANIFEST) # hide
+```
+
+```@raw html
+</details>
+```
+
+```@eval
+using TOML
+using Markdown
+version = TOML.parse(read("../../Project.toml", String))["version"]
+name = TOML.parse(read("../../Project.toml", String))["name"]
+link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+                "/assets/Manifest.toml"
+link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+               "/assets/Project.toml"
+Markdown.parse("""You can also download the
+[manifest]($link_manifest)
+file and the
+[project]($link_project)
+file.
+""")
+```