Skip to content

Commit a63120c

Browse files
authored
Update development instructions (#154)
… based on an inquiry from @s-zeng in #152 (comment)
1 parent 3f1d8cc commit a63120c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,24 @@ in
306306

307307
## Development
308308

309+
The logic for generating the Dhall code doesn't reside within this
310+
repository but actually resides within the
311+
[`dhall-openapi`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-openapi)
312+
subproject of the [`dhall-haskell`](https://github.com/dhall-lang/dhall-haskell)
313+
repository. That means that if you want to change the generated code you will
314+
need to do so in two steps:
315+
316+
* Make a pull request against the upstream `dhall-haskell` repository to
317+
change the code generated by `dhall-openapi`
318+
319+
* Make a pull request against this repository to pick up a newer reference
320+
to the `dhall-haskell` repository incorporating the change to `dhall-openapi`
321+
322+
If you try to create a pull request to amend the generated Dhall files directly
323+
then CI will reject the pull request since it verifies that the Dhall code
324+
stored in version control matches what `dhall-openapi` would generate from the
325+
Kubernetes OpenAPI specification.
326+
309327
### Updating the `dhall-openapi` dependency
310328

311329
The `dhall-openapi` dependency is a subproject of the `dhall-haskell`

0 commit comments

Comments
 (0)