technofab/kubenix
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/kubenix.git synced 2025-12-12 08:00:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs reset

Browse source
This commit is contained in:
Bryton Hall 2022-08-11 23:07:20 -04:00
parent 43371dba54
commit b874fce232
10 changed files with 225 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

24
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,24 @@
# Contributing
## Kubernetes versions
Edit [`./jobs/generators/default.nix`](./jobs/generators/default.nix) and add a block for the new version of Kubernetes in `generate.k8s`. For example:
```nix
{
name = "v1.23.nix";
path = generateK8S "v1.23" (builtins.fetchurl {
url = "https://github.com/kubernetes/kubernetes/raw/v1.23.0/api/openapi-spec/swagger.json";
sha256 = "0jivg8nlxka1y7gzqpcxkmbvhcbxynyrxmjn0blky30q5064wx2a";
});
}
```
Then build and copy all specs to [`modules/generated/`](./modules/generated/):
nix build '.#jobs.x86_64-linux.generators.k8s'
cp ./result/* modules/generated/
## Tests
Tests are executed through GitHub actions; see the [workflow definition](../kubenix/.github/workflows/ci.yml) for commands.