Skip to content

Commit

Permalink
Update CONTRIBUTING.md with instructions on releasing specs
Browse files Browse the repository at this point in the history
  • Loading branch information
teodanciu committed Jan 17, 2023
1 parent b99c4e8 commit cdc1ec3
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,21 @@ cabal configure <package-name> --ghc-options="-Wwarn"
cabal build <package-name>
```

## Publishing specifications
Pdf specs are stored as attachments to [github releases](https://github.com/input-output-hk/cardano-ledger/releases)
We can create a release that builds and attaches the latest specs, by triggering the [push-docs github action](https://github.com/input-output-hk/cardano-ledger/blob/master/.github/workflows/push-specs.yml).
This github action can be triggered by pushing a tag of the pattern: `v[0-9]+\.[0-9]+\.[0-9]+-cardano-ledger-specs`,
for example: v1.0.0-cardano-ledger-specs

For example, if we decide it's time to publish new versions of docs, and the current latest release is `v2.0.0-cardano-ledger-specs`.
We can do the following to publish the pdfs under release `v2.1.0-cardano-ledger-specs`:
```
git tag v2.1.0-cardano-ledger-specs`
git push origin v2.1.0-cardano-ledger-specs
```

This will create a new release that will be available as [latest](https://github.com/input-output-hk/cardano-ledger/releases/latest).

## Testing the Haskell programs

The tests can be run with cabal.
Expand Down

0 comments on commit cdc1ec3

Please sign in to comment.