forked from rook/rook
Sébastien Han
31db03fece
Finally! We can now stop editing manually our crds definition. Simply run `make crds-gen`. These two files: * `cluster/examples/kubernetes/ceph/crds.yaml` * `cluster/charts/rook-ceph/templates/resources.yaml` will be autogenerated for us. We rely on the controller-gen tool, it reads our API definitions from `pkg/apis/` and produces the CRD files accordingly. It uses "markers" to add extra yaml fields to the CRD, for instance we have a lot fields with: ``` nullable: true x-kubernetes-preserve-unknown-fields: true ``` The corresponding API type markers are: ``` // +kubebuilder:pruning:PreserveUnknownFields // +nullable ``` For more API convention see https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#optional-vs-required and for the markers see: https://book.kubebuilder.io/reference/markers/crd-validation.html Signed-off-by: Sébastien Han <seb@redhat.com>
24 lines
535 B
YAML
24 lines
535 B
YAML
name: Codespell
|
|
on:
|
|
push:
|
|
tags:
|
|
- v*
|
|
branches:
|
|
- master
|
|
pull_request:
|
|
branches:
|
|
- "master"
|
|
jobs:
|
|
codespell:
|
|
name: codespell
|
|
runs-on: ubuntu-18.04
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- name: codespell
|
|
uses: codespell-project/actions-codespell@master
|
|
with:
|
|
skip: .git,*.png,*.jpg,*.svg,*.sum
|
|
ignore_words_list: aks,keyserver,atleast,dne,ser,ist,files',ba,dum,iam,te,parm,assigment
|
|
check_filenames: true
|
|
check_hidden: true
|