Fix haddock documentation for cardano-constitution (#6284)

IntersectMBO · Jul 5, 2024 · 7a24d97 · 7a24d97
1 parent e5c0e76
commit 7a24d97
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 2 deletions.
diff --git a/.github/workflows/cardano-constitution-tests.yml b/.github/workflows/cardano-constitution-tests.yml
@@ -10,7 +10,7 @@ on:
 jobs:
  run:
  name: Run
- runs-on: [self-hosted, plutus-benchmark]
+ runs-on: [self-hosted, plutus-shared]
  steps:
  - name: Checkout
  uses: actions/checkout@main

diff --git a/.github/workflows/docusaurus-site.yml b/.github/workflows/docusaurus-site.yml
@@ -4,6 +4,9 @@
 name: "🦕 Docusaurus Site" 
 
 on:
+ push: 
+ branches: 
+ - master 
  workflow_dispatch:
 
 jobs:

diff --git a/.github/workflows/haddock-site.yml b/.github/workflows/haddock-site.yml
@@ -11,6 +11,7 @@ on:
  push: 
  branches:
  - master
+
  workflow_dispatch:
  inputs:
  ref:

diff --git a/.github/workflows/metatheory-site.yml b/.github/workflows/metatheory-site.yml
@@ -6,6 +6,10 @@
 name: "🔮 Metatheory Site"
 
 on:
+ push: 
+ branches: 
+ - master 
+
  workflow_dispatch:
  inputs:
  ref:

diff --git a/.github/workflows/nightly-testsuite.yml b/.github/workflows/nightly-testsuite.yml
@@ -19,7 +19,7 @@ env:
 jobs:
  run:
  name: Run
- runs-on: [self-hosted, plutus-benchmark]
+ runs-on: [self-hosted, plutus-shared]
  steps:
  - name: Checkout
  uses: actions/checkout@main

diff --git a/cardano-constitution/src/Cardano/Constitution/Validator/Sorted.hs b/cardano-constitution/src/Cardano/Constitution/Validator/Sorted.hs
@@ -7,6 +7,8 @@
 {-# OPTIONS_GHC -fplugin PlutusTx.Plugin #-}
 {-# OPTIONS_GHC -fplugin-opt PlutusTx.Plugin:target-version=1.1.0 #-}
 {-# OPTIONS_GHC -fplugin-opt PlutusTx.Plugin:remove-trace #-}
+{-# OPTIONS_GHC -fplugin-opt PlutusTx.Plugin:defer-errors #-}
+
 module Cardano.Constitution.Validator.Sorted
  ( constitutionValidator
  , defaultConstitutionValidator

diff --git a/cardano-constitution/src/Cardano/Constitution/Validator/Unsorted.hs b/cardano-constitution/src/Cardano/Constitution/Validator/Unsorted.hs
@@ -7,6 +7,8 @@
 {-# OPTIONS_GHC -fplugin PlutusTx.Plugin #-}
 {-# OPTIONS_GHC -fplugin-opt PlutusTx.Plugin:target-version=1.1.0 #-}
 {-# OPTIONS_GHC -fplugin-opt PlutusTx.Plugin:remove-trace #-}
+{-# OPTIONS_GHC -fplugin-opt PlutusTx.Plugin:defer-errors #-}
+
 module Cardano.Constitution.Validator.Unsorted
  ( constitutionValidator
  , defaultConstitutionValidator

diff --git a/scripts/combined-haddock.sh b/scripts/combined-haddock.sh
@@ -75,6 +75,8 @@ PLUTUS_VERSION="$(find ${BUILD_CONTENTS}/plutus-core-* -printf '%f\n' -quit | se
 
 GIT_REV="$(git rev-parse HEAD)"
 
+GIT_REV_SHORT="$(git rev-parse --short HEAD)"
+
 
 # Here we merge each package's internal libraries into a single folder, for example:
 # Merge:
@@ -125,6 +127,9 @@ done
 
 echo "Writing the prologue"
 cat << EOF > "${BUILD_DIR}/haddock.prologue"
+
+Last updated on $(date +"%F") from [IntersectMBO/plutus@\`$GIT_REV_SHORT\`](https://github.com/IntersectMBO/plutus/tree/$GIT_REV)
+
 == Handy module entrypoints
 
  * "PlutusTx": Compiling Haskell to PLC (Plutus Core; on-chain code).