dhall-lang/dhall-kubernetes
1
1
Fork 0
mirror of https://github.com/dhall-lang/dhall-kubernetes.git synced 2024-09-17 10:27:08 +03:00
Code Issues Projects Releases Wiki Activity

Update docs/README.md.dhall to match README.md (#159)

Browse Source 
In a63120cd21 and
3fdb6ca551 README.md had been
updated directly, without updating the "source"
docs/README.md.dhall. This commit rectifies that.
This commit is contained in:
Will Sewell 2021-01-17 05:24:15 +00:00 committed by GitHub
parent 079178f537
commit 4dd75dd735
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
1.17/README.md
View File

@ -306,6 +306,24 @@ in
## Development
The logic for generating the Dhall code doesn't reside within this
repository but actually resides within the
[`dhall-openapi`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-openapi)
subproject of the [`dhall-haskell`](https://github.com/dhall-lang/dhall-haskell)
repository. That means that if you want to change the generated code you will
need to do so in two steps:
* Make a pull request against the upstream `dhall-haskell` repository to
change the code generated by `dhall-openapi`
* Make a pull request against this repository to pick up a newer reference
to the `dhall-haskell` repository incorporating the change to `dhall-openapi`
If you try to create a pull request to amend the generated Dhall files directly
then CI will reject the pull request since it verifies that the Dhall code
stored in version control matches what `dhall-openapi` would generate from the
Kubernetes OpenAPI specification.
### Updating the `dhall-openapi` dependency
The `dhall-openapi` dependency is a subproject of the `dhall-haskell`
@ -349,6 +367,8 @@ To add a new supported release, run:
./scripts/add-kubernetes-release.sh "${VERSION}"
```
… and then create a pull request out of the generated files.
If you want to make a specific release the preferred release, run:
```

20
docs/README.md.dhall
View File

@ -154,6 +154,24 @@ in
## Development
The logic for generating the Dhall code doesn't reside within this
repository but actually resides within the
[`dhall-openapi`](https://github.com/dhall-lang/dhall-haskell/tree/master/dhall-openapi)
subproject of the [`dhall-haskell`](https://github.com/dhall-lang/dhall-haskell)
repository. That means that if you want to change the generated code you will
need to do so in two steps:
* Make a pull request against the upstream `dhall-haskell` repository to
change the code generated by `dhall-openapi`
* Make a pull request against this repository to pick up a newer reference
to the `dhall-haskell` repository incorporating the change to `dhall-openapi`
If you try to create a pull request to amend the generated Dhall files directly
then CI will reject the pull request since it verifies that the Dhall code
stored in version control matches what `dhall-openapi` would generate from the
Kubernetes OpenAPI specification.
### Updating the `dhall-openapi` dependency
The `dhall-openapi` dependency is a subproject of the `dhall-haskell`
@ -197,6 +215,8 @@ To add a new supported release, run:
./scripts/add-kubernetes-release.sh "''${VERSION}"
```
… and then create a pull request out of the generated files.
If you want to make a specific release the preferred release, run:
```