Skip to content

Commit

Permalink
Deploy haddock to github pages
Browse files Browse the repository at this point in the history
Signed-off-by: Sam Foo <sam.foo@iohk.io>
  • Loading branch information
sfoo-iohk committed Feb 8, 2023
1 parent a8e7473 commit b70d83f
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 6 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/haddock.yml
@@ -0,0 +1,27 @@
name: "Build and Deploy to Github Pages"
on:
push:
branches:
- master
jobs:
build-haddock-site:
runs-on: ubuntu-latest
permissions:
contents: write
environment:
name: github-pages
steps:
- uses: actions/checkout@v3
- uses: nixbuild/nix-quick-install-action@v21
with:
nix_conf: |
experimental-features = nix-command flakes
accept-flake-config = true
- name: Build haddock site
run: |
nix build .#combined-plutus-haddock
mkdir dist
cp -RL ./result/share/doc/* ./dist/
- uses: JamesIves/github-pages-deploy-action@v4
with:
folder: dist
9 changes: 3 additions & 6 deletions nix/cells/plutus/packages/combined-plutus-haddock.nix
Expand Up @@ -24,12 +24,9 @@ cell.library.combine-haddock {
* "PlutusTx": Compiling Haskell to PLC (Plutus Core; on-chain code).
* "PlutusTx.Prelude": Haskell prelude replacement compatible with PLC.
* "Plutus.Contract": Writing Plutus apps (off-chain code).
* "Ledger.Constraints": Constructing and validating Plutus
transactions. Built on "PlutusTx" and "Plutus.Contract".
* "Ledger.Typed.Scripts": A type-safe interface for spending and
producing script outputs. Built on "PlutusTx".
* "Plutus.Trace.Emulator": Testing Plutus contracts in the emulator.
* "PlutusCore": Programming language in which scripts on the Cardano blockchain are written.
* "PlutusIR": Intermediate Representation language that compiles to Plutus Core.
* "UntypedPlutusCore": On-chain Plutus code.
'';
};
}

0 comments on commit b70d83f

Please sign in to comment.