Merge branch 'epics-extensions:master' into default-option-phoebus

.github/dependabot.yml

@@ -4,3 +4,6 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      non-breaking-changes:
+        update-types: [minor, patch]

.github/workflows/backport.yml

@@ -20,11 +20,14 @@ jobs:
     if: github.repository_owner == 'epics-extensions' && github.event.pull_request.merged == true && (github.event_name != 'labeled' || startsWith('backport', github.event.label.name))
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
         with:
           ref: ${{ github.event.pull_request.head.sha }}
+          # Credentials are needed to push to a remote branch,
+          # before creating a pull request
+          persist-credentials: true
       - name: Create backport PRs
-        uses: korthout/backport-action@7e7cb1977d64d20339e8fdec12c0a1a065371de7 # v3.0.0
+        uses: korthout/backport-action@be567af183754f6a5d831ae90f648954763f17f5 # v3.1.0
         with:
           # Config README: https://github.com/korthout/backport-action#backport-action
           branch_name: backport/${pull_number}-to-${target_branch}

.github/workflows/book-gh-pages.yml

@@ -18,17 +18,20 @@ concurrency:
 
 jobs:
   deploy:
+    if: "github.repository_owner == 'epics-extensions'"
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
-      - uses: cachix/install-nix-action@ba0dd844c9180cbf77aa72a116d6fbc515d0e87b # v27
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+        with:
+          persist-credentials: false
+      - uses: cachix/install-nix-action@3715ab1a11cac9e991980d7b4a28d80c7ebdd8f9 # v27
       - name: "Build documentation book"
         run: |
-          nix build '.#book' --print-build-logs
-          cp -Lr --no-preserve=mode,ownership ./result/ ./book
+          nix build '.#docs' --print-build-logs
+          cp -Lr --no-preserve=mode,ownership ./result/share/doc/epnix/html ./book
       - name: Setup Pages
         uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
       - name: Upload artifact

.github/workflows/editorconfig.yml

@@ -3,14 +3,16 @@ name: "Check EditorConfig"
 permissions: read-all
 
 on:
-  push:
-  pull_request:
+  pull_request_target:
+    types: [opened, synchronize, reopened, edited]
 
 jobs:
   editorconfig:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
-    - uses: cachix/install-nix-action@ba0dd844c9180cbf77aa72a116d6fbc515d0e87b # v27
+    - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+      with:
+        persist-credentials: false
+    - uses: cachix/install-nix-action@3715ab1a11cac9e991980d7b4a28d80c7ebdd8f9 # v27
     - name: "Check EditorConfig"
       run: nix run 'nixpkgs#eclint' --inputs-from .

.github/workflows/formatting.yml

@@ -3,14 +3,16 @@ name: "Check Formatting"
 permissions: read-all
 
 on:
-  push:
-  pull_request:
+  pull_request_target:
+    types: [opened, synchronize, reopened, edited]
 
 jobs:
   alejandra:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
-    - uses: cachix/install-nix-action@ba0dd844c9180cbf77aa72a116d6fbc515d0e87b # v27
+    - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+      with:
+        persist-credentials: false
+    - uses: cachix/install-nix-action@3715ab1a11cac9e991980d7b4a28d80c7ebdd8f9 # v27
     - name: "Check Formatting"
       run: nix fmt -- --check .

.github/workflows/update-flake-lock.yml

@@ -0,0 +1,40 @@
+name: Update flake.lock
+on:
+  workflow_dispatch: # allows manual triggering
+  schedule:
+    - cron: '0 0 * * 0' # runs weekly on Sunday at 00:00
+
+# WARNING:
+# When extending this action, be aware that $GITHUB_TOKEN allows write access to
+# the GitHub repository. This means that it should not evaluate user input in a
+# way that allows code injection.
+
+permissions:
+  contents: read
+
+jobs:
+  lockfile:
+    if: "github.repository_owner == 'epics-extensions'"
+    strategy:
+      matrix:
+        branch:
+          - master
+          - nixos-24.05
+          - nixos-23.11
+          - nixos-23.05
+    permissions:
+      contents: write # to create branch
+      pull-requests: write # to create PR to backport
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+        with:
+          ref: ${{ matrix.branch }}
+          persist-credentials: false
+      - uses: cachix/install-nix-action@3715ab1a11cac9e991980d7b4a28d80c7ebdd8f9 # v27
+      - uses: DeterminateSystems/update-flake-lock@a2bbe0274e3a0c4194390a1e445f734c597ebc37 # v24
+        with:
+          branch: "update-flake-lock/${{ matrix.branch }}"
+          pr-title: "[${{ matrix.branch }}] Update flake.lock"
+          pr-labels: |
+            dependencies

.gitlab-ci.yml

@@ -1,4 +1,9 @@
+workflow:
+  auto_cancel:
+    on_new_commit: interruptible
+
 default:
+  interruptible: true
   tags:
     - nix
 
@@ -26,8 +31,8 @@ formatting:
 manpages:
   stage: deploy
   script:
-    - nix build $NIX_BUILD_FLAGS '.#manpages'
-    - cp -Lr ./result manpages
+    - nix build $NIX_BUILD_FLAGS '.#docs'
+    - cp -Lr ./result/share/man manpages
   artifacts:
     name: "manpages-$CI_COMMIT_REF_SLUG"
     paths:
@@ -36,8 +41,8 @@ manpages:
 pages:
   stage: deploy
   script:
-    - nix build $NIX_BUILD_FLAGS '.#book'
-    - cp -Lr ./result public
+    - nix build $NIX_BUILD_FLAGS '.#docs'
+    - cp -Lr ./result/share/doc/epnix/html public
   artifacts:
     name: "book"
     paths:

.vale.ini

@@ -1,12 +1,12 @@
-StylesPath = doc/_vale
+StylesPath = docs/_vale
 MinAlertLevel = suggestion
 
 Vocab = EPNix
 
 # External packages
 Packages = alex, Google, Microsoft, proselint, RedHat, write-good
-# Only Markdown and .txt files; change to whatever you're using.
-[*.md]
+
+[*.{md,rst}]
 # List of styles to load.
 BasedOnStyles = alex, Google, Microsoft, proselint, RedHat, Vale, write-good
 

README.md

@@ -1,6 +1,6 @@
 # EPNix
 
-![](./doc/logo.svg)
+![](./docs/logo.svg)
 
 EPNix (pronunciation: like you are high on mushrooms) packages EPICS-related software by using the [Nix] package manager.
 
@@ -11,7 +11,7 @@ It's made of three parts:
 -   NixOS modules
 
 The EPICS IOC framework lets you package, deploy, and test EPICS IOCs by using the Nix package manager, which provides several benefits.
-For more information, see the [EPICS IOCs introduction].
+For more information, see the [EPICS IOC documentation].
 
 EPNix also packages other EPICS-related tools, such as procServ, Phoebus, and so on.
 You can build them by using Nix, while having a strong guarantee that they work as-is.
@@ -21,12 +21,12 @@ Note: providing a cache server that enables you to download dependencies pre-com
 
 EPNix also provides NixOS modules, which are instructions on how to configure various EPICS-related services on NixOS machines (for example the Phoebus alarm server).
 EPNix strives to have integration tests for each of those module.
-For more information, see the [NixOS modules introduction].
+For more information, see the [NixOS services documentation].
 
   [Nix]: https://nixos.org/guides/how-nix-works.html
-  [EPICS IOCs introduction]: https://epics-extensions.github.io/EPNix/ioc/introduction.html
+  [EPICS IOC documentation]: https://epics-extensions.github.io/EPNix/ioc/
   [Packages list]: https://epics-extensions.github.io/EPNix/pkgs/packages.html
-  [NixOS modules introduction]: https://epics-extensions.github.io/EPNix/nixos/introduction.html
+  [NixOS services documentation]: https://epics-extensions.github.io/EPNix/nixos-services/
 
 ## Getting started building IOCs