github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-06 11:42:14 +00:00
Code Issues Projects Releases Wiki Activity

Add UPDATE_API_KNOWN_VIOLATIONS=true to Makefile.generated_files

Browse Source 
One can run:
    make generated_files UPDATE_API_KNOWN_VIOLATIONS=true
to update the checked-in known API violation exceptions list.

Also updated README and the error message on how to resolve the
failure.
This commit is contained in:
Haowei Cai
2018-11-01 17:21:40 -07:00
parent bce51cc574
commit dcc062d812
2 changed files with 35 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
api/api-rules/README.md
View File

@@ -1,9 +1,11 @@
## Existing API Rule Violations
# Existing API Rule Violations
This folder contains the checked-in report file of known API rule violations.
The file violation\_exceptions.list is used by Make rule during OpenAPI spec generation to make
sure that no new API rule violation is introduced into our code base.
## API Rule Violation Format
The report file [violation\_exceptions.list](./violation_exceptions.list) is in format of:
* ***API rule violation: \<RULE\>,\<PACKAGE\>,\<TYPE\>,\<FIELD\>***
@@ -12,11 +14,29 @@ e.g.
* ***API rule violation: names_match,k8s.io/api/core/v1,Event,ReportingController***
And the violation list is sorted alphabetically in each of the \<RULE\>, \<PACKAGE\>, \<TYPE\>, \<FIELD\> levels.
## How to resolve API Rule Check Failure
Make rule returns an error when the newly generated violation report differs from this
checked-in violation report. If a new API rule violation is detected, please fix
the API Go source file to pass the API rule check. **The entries in the checked-in
violation report should only be removed when existing API rule violation is
being fixed, but not added.**
checked-in violation report.
Our goal is that exceptions should never be added to this list, only fixed and removed.
For new APIs, this is a hard requirement. For APIs that are e.g. being moved between
versions or groups without other changes, it is OK for your API reviewer to make an
exception.
If you're removing violations from the exception list, or if you have good
reasons to add new violations to this list, please update the file using:
- `make generated_files UPDATE_API_KNOWN_VIOLATIONS=true`
It is up to API reviewers to review the list and make sure new APIs follow our API conventions.
**NOTE**: please don't hide changes to this file in a "generated changes" commit, treat it as
source code instead.
## API Rules Being Enforced
For more information about the API rules being checked, please refer to
https://github.com/kubernetes/kube-openapi/tree/master/pkg/generators/rules