Skip to content

Commit 1825a2a

Browse files
Updates README
Adds nophase linter to README.
1 parent 0c7b7d0 commit 1825a2a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ It also supports the `// +kubebuilder:validation:Optional` and `// +kubebuilder:
164164

165165
If you prefer to use the Kubebuilder markers instead, you can change the preference in the configuration.
166166

167+
167168
### Configuration
168169

169170
```yaml
@@ -201,6 +202,11 @@ It will suggest to remove the pointer from the field, and update the `json` tag
201202
If you prefer not to suggest fixes for pointers in required fields, you can change the `pointerPolicy` to `Warn`.
202203
The linter will then only suggest to remove the `omitempty` value from the `json` tag.
203204

205+
## Nophase
206+
207+
The `nophase` linter checks that the fields in the API types don't contain a 'Phase', or any field which contains 'Phase' as a substring, e.g MachinePhase.
208+
209+
204210
# Contributing
205211

206212
New linters can be added by following the [New Linter][new-linter] guide.

0 commit comments

Comments
 (0)