Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: generate should include docs-api #1246

Merged
merged 5 commits into from
Apr 4, 2023
Merged

Conversation

zirain
Copy link
Contributor

@zirain zirain commented Apr 3, 2023

auto update references

Signed-off-by: hejianpeng <hejianpeng2@huawei.com>
@zirain zirain requested a review from a team as a code owner April 3, 2023 07:57
@codecov
Copy link

codecov bot commented Apr 3, 2023

Codecov Report

Merging #1246 (2a3adb6) into main (7d20c95) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1246   +/-   ##
=======================================
  Coverage   63.93%   63.93%           
=======================================
  Files          79       79           
  Lines        9931     9931           
=======================================
  Hits         6349     6349           
  Misses       3163     3163           
  Partials      419      419           

see 2 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Signed-off-by: hejianpeng <hejianpeng2@huawei.com>
tools/src/crd-ref-docs/go.mod Outdated Show resolved Hide resolved
@arkodg
Copy link
Contributor

arkodg commented Apr 3, 2023

thanks for raising this @zirain
looks like the core fix tied to the PR title is

generate: kube-generate go.generate docs-api

would it be possible to split this up into 2 PRs so the other useful fix of linking upstream Gateway API docs can be brought in later once the PR you raised has made its way into the upstream repo ?

@arkodg
Copy link
Contributor

arkodg commented Apr 3, 2023

you can circumvent the situation by ignoring the type/field for now

- "(EnvoyProxy|AuthenticationFilter|RateLimitFilter)List$"

@@ -48,5 +48,6 @@
"MD047": false,
"MD048": false,
"MD049": false,
"MD050": false
"MD050": false,
"MD051": false
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add this line to circumvent lint error

Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks !

@Xunzhuo Xunzhuo merged commit bd53e1d into envoyproxy:main Apr 4, 2023
@zirain zirain deleted the gen-api-docs branch April 4, 2023 06:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants