Skip to content

Commit 1459f50

Browse files
teodanciuJaredCorduan
authored andcommitted
Update CONTRIBUTING.md with instructions on releasing specs
1 parent 1910ccc commit 1459f50

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,22 @@ cabal configure <package-name> --ghc-options="-Wwarn"
9191
cabal build <package-name>
9292
```
9393

94+
## Publishing specifications
95+
PDF specs are stored as attachments to [github releases](https://github.com/input-output-hk/cardano-ledger/releases)
96+
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).
97+
This github action can be triggered by pushing a tag of the pattern: `cardano-ledger-spec-YYYY-MM-DD`, for example: `cardano-ledger-spec-2023-01-17`
98+
99+
For example, if we decide it's time to publish new versions of docs,
100+
we can do the following to publish the PDFs under release `cardano-ledger-spec-2023-03-21`:
101+
```
102+
git tag cardano-ledger-spec-2023-03-21
103+
git push origin cardano-ledger-spec-2023-03-21
104+
```
105+
106+
This will create a new release that will be available as [latest](https://github.com/input-output-hk/cardano-ledger/releases/latest).
107+
Make sure that the `YYYY-MM-DD` part in the tag name is alphabetically greater than the rest, otherwise the release won't be tagged as `latest`.
108+
Using the current date should ensure that this is the case.
109+
94110
## Testing the Haskell programs
95111

96112
The tests can be run with cabal.

0 commit comments

Comments
 (0)