Merge remote-tracking branch 'origin/master' into ana/data-value-ledg…

…er-api

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -9,7 +9,7 @@ body:
     attributes:
       value: |
         Thanks for taking the time to fill out this bug report.
-        Please check the existing issues, [Plutus Docs](https://plutus.readthedocs.io/en/latest/) and [Cardano Stack Exchange](https://cardano.stackexchange.com/) before raising.
+        Please check the existing issues, [Plutus Docs](https://plutus.cardano.intersectmbo.org/docs) and [Cardano Stack Exchange](https://cardano.stackexchange.com/) before raising.
   - type: textarea
     id: summary
     attributes:

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -8,7 +8,7 @@ body:
     attributes:
       value: |
         Thanks for taking the time to fill out this feature request.
-        Please check the existing issues and [Plutus Docs](https://plutus.readthedocs.io/en/latest/) before raising.
+        Please check the existing issues and [Plutus Docs](https://plutus.cardano.intersectmbo.org/docs) before raising.
   - type: textarea
     id: description
     attributes:

.github/workflows/broken-links.yml

@@ -0,0 +1,24 @@
+# This job checks for broken links in various files in the repo.
+
+name: "🔗 Broken Links"
+
+on:
+  workflow_dispatch: # Or manually dispatch the job
+  push:
+    branches:
+      master
+
+jobs:
+  check:
+    name: Check
+    runs-on: [plutus-shared, self-hosted]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@main
+
+      - name: Run Linkchecker
+        run: |
+          nix develop --no-warn-dirty --accept-flake-config --command ./scripts/check-broken-links.sh
+
+  
+

.github/workflows/cardano-constitution-tests.yml

@@ -0,0 +1,21 @@
+# This workflow runs the nighlty cardano-constitution tests 
+
+name: "🗽 Cardano Constitution Tests"
+
+on:
+  workflow_dispatch: 
+  schedule:
+    - cron: 0 2 * * * # Daily at 2am
+
+jobs:
+  run:
+    name: Run
+    runs-on: [self-hosted, plutus-shared]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@main
+
+      - name: Run Tests
+        run: | 
+          pushd plutus-core
+          nix run --no-warn-dirty --accept-flake-config .#cardano-constitution-test

.github/workflows/check-changelog.yml → .github/workflows/changelog-label.yml

@@ -1,23 +1,31 @@
-name: Check Changelog
+# This job enforces that: either some changelog.d/** files were added by the 
+# PR, or the PR has the "No Changelog Required" label.  
+
+name: "🏷️ Changelog Label"
+
 on:
   pull_request:
-    types: [ opened, synchronize, labeled, unlabeled ]
+    types: [ opened, reopened, synchronize, labeled, unlabeled ]
+
 jobs:
-  check-changelog:
+
+  check:
+    name: Check
     runs-on: [ubuntu-latest]
+    permissions:
+      issues: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@main
 
-      - name: Find Changed Files in changelog.d
+      - name: Find Changed Files
         id: changed-files
-        uses: tj-actions/changed-files@v44
+        uses: tj-actions/changed-files@main
         with:
           files: '**/changelog.d/**'
 
-      - name: Enforce New File or 'No Changelog Required' Label
-        uses: actions/github-script@v7
-        # don't require changelogs for draft PRs
+      - name: Enforce Label
+        uses: actions/github-script@main
         if: github.event.pull_request.draft == false
         with:
           script: | 

.github/workflows/cost-model-benchmark.yml

@@ -0,0 +1,31 @@
+# This workflow runs the cost model benchmark and uploads the results as a 
+# GitHub artifact.
+
+name: "💰 Cost Model Benchmark" 
+
+on:
+  workflow_dispatch:
+    inputs:
+      entra-bench-args:
+        description: 'extra argument(s) to pass to the cost-model-budgeting-bench command'
+        default: ''
+        type: string
+
+jobs:
+  run:
+    name: Run
+    runs-on: [self-hosted, plutus-benchmark]
+    timeout-minutes: 1800 # (30 hours) These benchmarks take over 10 hours to run.
+    steps:
+      - name: Checkout
+        uses: actions/checkout@main
+
+      - name: Run Benchmark
+        run: nix --accept-flake-config run .#cost-model-budgeting-bench -- --csv results.csv ${{ inputs.entra-bench-args }}
+
+      - name: Upload Results
+        uses: actions/upload-artifact@main
+        with:
+          name: results
+          path: results.csv
+          if-no-files-found: error

.github/workflows/docusaurus-site.yml

@@ -0,0 +1,33 @@
+# This workflow builds and publishes the Docusaurus site to:
+# https://plutus.cardano.intersectmbo.org/docs
+
+name: "🦕 Docusaurus Site" 
+
+on:
+  push: 
+    branches: 
+      - master 
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    name: Deploy 
+    runs-on: [self-hosted, plutus-shared]
+    permissions:
+      contents: write
+    environment:
+      name: github-pages
+    steps:
+      - name: Checkout
+        uses: actions/checkout@main
+
+      - name: Build Site 
+        working-directory: doc/docusaurus
+        run: nix develop --no-warn-dirty --accept-flake-config --command bash -c 'yarn && yarn build'
+
+      - name: Deploy Site 
+        uses: JamesIves/github-pages-deploy-action@v4.6.3
+        with:
+          folder: doc/docusaurus/build
+          target-folder: docs
+          single-commit: true

.github/workflows/haddock-site.yml

@@ -0,0 +1,77 @@
+# This workflow builds and publishes the Haddock site to:
+# https://plutus.cardano.intersectmbo.org/haddock/$version
+# And optionally to:
+# https://plutus.cardano.intersectmbo.org/haddock/latest
+# On push to master, this workflows publishes to:
+# https://plutus.cardano.intersectmbo.org/haddock/master
+
+name: "📜 Haddock Site"
+
+on:
+  push: 
+    branches:
+      - master
+
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: |
+          The $ref to build off of, e.g. "1.29.0.0", "master", or any other valid git ref.
+          When making a release, this is usually the version tag, e.g. "1.29.0.0", and will be
+          equal to the $destination input below. When back-porting this could be a commit sha instead.
+        required: true
+        type: string
+
+      destination:
+        description: |
+          The $destination folder, e.g. when "1.29.0.0" the haddock will be deploy to:
+          https://plutus.cardano.intersectmbo.org/haddock/1.29.0.0
+        required: true
+        type: string
+
+      latest: 
+        description: |
+          If true, then the haddock site will also be deploy to:
+          https://plutus.cardano.intersectmbo.org/haddock/latest.
+          You want to leave this to true unless you are deploying old versions or back-porting.
+        type: boolean
+        required: true 
+        default: true
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: [self-hosted, plutus-shared]
+    permissions:
+      contents: write
+    environment:
+      name: github-pages
+    steps:
+      - name: Checkout
+        uses: actions/checkout@main
+        with:
+          ref: ${{ inputs.ref || github.ref_name }}
+
+      - name: Checkout Haddock Script
+        run: | 
+          git fetch origin master
+          git checkout origin/master ./scripts/combined-haddock.sh
+            
+      - name: Build Site
+        run: | 
+          nix develop --no-warn-dirty --accept-flake-config --command ./scripts/combined-haddock.sh _haddock all
+
+      - name: Deploy Site
+        uses: JamesIves/github-pages-deploy-action@v4.6.3
+        with:
+          folder: _haddock
+          target-folder: haddock/${{ inputs.destination || github.ref_name }}
+          single-commit: true
+
+      - name: Deploy Site (latest)
+        if: ${{ inputs.latest == true }}
+        uses: JamesIves/github-pages-deploy-action@v4.6.3
+        with:
+          folder: _haddock
+          target-folder: haddock/latest
+          single-commit: true

.github/workflows/longitudinal-benchmark.yml

@@ -1,12 +1,13 @@
-# Longitudinal Benchmarks 
-# 
-# This workflow will run the benchmarks defined in the environment variable BENCHMARKS.
-# It will collect and aggreate the benchmark output, format it and feed it to github-action-benchmark.
+# This workflow runs the benchmarks defined in the environment variable BENCHMARKS.
+# It will collect and aggreate the benchmark output, format it and feed it to the
+# github-action-benchmark action.
 #
-# The benchmark charts are live at https://input-output-hk.github.io/plutus/dev/bench
-# The benchmark data is available at https://input-output-hk.github.io/plutus/dev/bench/data.js
+# The benchmark charts are live at https://plutus.cardano.intersectmbo.org/dev/bench
+# The benchmark data is available at https://plutus.cardano.intersectmbo.org/dev/bench/data.js
+#
+# This is a performance regression check that is run on every push master.
 
-name: Longitudinal Benchmarks
+name: "🩺 Longitudinal Benchmark"
 
 on:
   push:
@@ -20,27 +21,25 @@ permissions:
   contents: write
 
 jobs:
-  longitudinal-benchmarks:
-    name: Performance regression check
+  run:
+    name: Run
     runs-on: [self-hosted, plutus-benchmark]
     steps:
-      - uses: actions/checkout@v4
-      - uses: cachix/install-nix-action@V27
-        with:
-          nix_path: nixpkgs=channel:nixos-unstable
+      - name: Checkout 
+        uses: actions/checkout@main 
 
-      - name: Run benchmarks
+      - name: Run Benchmarks
         env: 
           BENCHMARKS: "validation validation-decode nofib marlowe"
         run: nix develop --no-warn-dirty --accept-flake-config --command bash ./scripts/run-longitudinal-benchmarks.sh
 
-      # We need this otherwise the next step (Store benchmark result) will fail with:
+      # We need this otherwise the next step will fail with:
       # `pre-commit` not found.  Did you forget to activate your virtualenv?
       # This is because github-action-benchmark will call git commit outside nix develop.
       - name: Disable Git Hooks
         run: git config core.hooksPath no-hooks
 
-      - name: Store benchmark result
+      - name: Deploy Results
         uses: benchmark-action/github-action-benchmark@v1.20.3
         with:
           name: Plutus Benchmarks
@@ -51,9 +50,10 @@ jobs:
           auto-push: true
           # Enable alert commit comment
           comment-on-alert: true
-          # Mention @IntersectMBO/plutus-core in the commit comment
+          # Mention @IntersectMBO/plutus-core in the commit comment so that the 
+          # team is notified via GitHub.
           alert-comment-cc-users: '@IntersectMBO/plutus-core'
-          # Percentage value like "110%". 
           # It is a ratio indicating how worse the current benchmark result is. 
-          # For example, if we now get 110 ns/iter and previously got 100 ns/iter, it gets 110% worse.
+          # For example, if we now get 110 ns/iter and previously got 100 ns/iter, it got 10% worse.
+          # In this case we alert if it gets 5% worse.
           alert-threshold: '105%'