Release 0.1.5 (#38)

This PR merges the latest state of dev into the main and starts the
release pipeline for `0.1.4 -> 0.1.5`. Since there are no breaking
changes, and mostly maintenance, the new version is just ticking up the
patch-version of the package.

For more details on this release, see #39 

## Todos

- [x] tick up the version in `Project.toml`
- [x] add `CHANGELOG.md` with a section to summarize the changes made
- [x] tag the PRs related to this release (using milestones)

---------

Co-authored-by: Uwe Hernandez Acosta <[email protected]>
Co-authored-by: Steiniger, Dr. Klaus (FWKT) - 4878 <[email protected]>
Co-authored-by: AlexanderJCS <[email protected]>
Co-authored-by: Simeon Ehrig <[email protected]>
Co-authored-by: Anton Reinhard <[email protected]>
Co-authored-by: Anton Reinhard <[email protected]>
Co-authored-by: AntonReinhard <[email protected]>
Co-authored-by: Tom Jungnickel <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: CompatHelper Julia <[email protected]>

.JuliaFormatter.toml

@@ -0,0 +1,2 @@
+style = "blue"
+

.formatting/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"

.formatting/format_all.jl

@@ -0,0 +1,12 @@
+using JuliaFormatter
+
+# we asume the format_all.jl script is located in QEDbase.jl/.formatting
+project_path = Base.Filesystem.joinpath(Base.Filesystem.dirname(Base.source_path()), "..")
+
+not_formatted = format(project_path; verbose=true)
+if not_formatted
+    @info "Formatting verified."
+else
+    @warn "Formatting verification failed: Some files are not properly formatted!"
+end
+exit(not_formatted ? 0 : 1)

.github/workflows/BuildDelopyDoc.yml

@@ -0,0 +1,31 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.9'
+      - name: Add custom registry 
+        run: |
+          julia --project=docs/ -e 'import Pkg; Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/QEDjl-project/registry.git"));'
+          julia --project=docs/ -e 'import Pkg; Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/JuliaRegistries/General"));'
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+        run: julia --project=docs/ docs/make.jl

.github/workflows/CompatHelper.yml

@@ -0,0 +1,51 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if Julia is already available in the PATH
+        id: julia_in_path
+        run: which julia
+        continue-on-error: true
+      - name: Install Julia, but only if it is not already available in the PATH
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+          arch: ${{ runner.arch }}
+        if: steps.julia_in_path.outcome != 'success'
+      - name: "Add the General registry via Git"
+        run: |
+          import Pkg
+          ENV["JULIA_PKG_SERVER"] = ""
+          Pkg.Registry.add("General")
+        shell: julia --color=yes {0}
+      - name: "Add QED custom registry"
+        run: |
+          import Pkg
+          ENV["JULIA_PKG_SERVER"] = ""
+          Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/QEDjl-project/registry.git"))
+        shell: julia --color=yes {0}
+      - name: "Install CompatHelper"
+        run: |
+          import Pkg
+          name = "CompatHelper"
+          uuid = "aa819f21-2bde-4658-8897-bab36330d9b7"
+          version = "3"
+          Pkg.add(; name, uuid, version)
+        shell: julia --color=yes {0}
+      - name: "Run CompatHelper"
+        run: |
+          import CompatHelper
+          CompatHelper.main(; master_branch="dev")
+        shell: julia --color=yes {0}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+          COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}

.github/workflows/formatter.yaml

@@ -0,0 +1,16 @@
+name: formatter
+on: [pull_request]
+jobs:
+  formatter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout repo
+        uses: actions/checkout@v4
+      - name: install Julia
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: 1.9
+      - name: Install Julia requirements
+        run: julia --project=${GITHUB_WORKSPACE}/.formatting -e 'import Pkg; Pkg.instantiate()'
+      - name: Check code style
+        run: julia --project=${GITHUB_WORKSPACE}/.formatting ${GITHUB_WORKSPACE}/.formatting/format_all.jl