Skip to content

Commit 16d4981

Browse files
committed
update readme output section
Signed-off-by: everettraven <everettraven@gmail.com>
1 parent d116560 commit 16d4981

1 file changed

Lines changed: 28 additions & 2 deletions

File tree

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ For more examples, see the `examples/` directory.
7878

7979
### Output
8080

81-
`synkr` currently only outputs JSON data for each configured source.
81+
`synkr` currently supports Markdown and JSON output formats.
8282

83-
An example of the output (configured with a single source):
83+
An example of the JSON output (configured with a single source):
8484

8585
```json
8686
{
@@ -116,6 +116,32 @@ An example of the output (configured with a single source):
116116
}
117117
```
118118

119+
An example of the Markdown output:
120+
```md
121+
# GitHub - kubernetes-sigs/kube-api-linter
122+
## [Issue][open]: Feature: Allow configuration of custom enum markers for `maxlength` linter
123+
**URL**: https://github.com/kubernetes-sigs/kube-api-linter/issues/95
124+
**Author**: *everettraven*
125+
**Assignees**:
126+
127+
128+
129+
In OpenShift, we have some custom markers that set enum values for a field and this results in the `maxlength` linter stating that a field/type alias should have a maximum length when using this custom marker instead of the standard `kubebuilder:validation:Enum` marker.
130+
131+
While this particular case is OpenShift-specific, I think it is reasonable to make a generic way to extend this detection logic as there may be other vendors and/or projects that use their own custom markers for CRD generation.
132+
133+
## [PullRequest][open]: markers: fix a bug when parsing expressions with commas present in value
134+
**URL**: https://github.com/kubernetes-sigs/kube-api-linter/pull/103
135+
**Author**: *everettraven*
136+
**Assignees**:
137+
138+
`cncf-cla: yes` `size/M`
139+
140+
Fixes #99
141+
142+
Instead of splitting on solely the `,` character, we now do some more robust normalization for parsing of markers to handle the scenarios where a marker may specify an expression with attributes the have a `,` in their value.
143+
```
144+
119145
### Help
120146
```sh
121147

0 commit comments

Comments
 (0)