Fix the docgen tool #3199

nunnatsa · 2024-12-09T13:41:21Z

What this PR does / why we need it

rewrite parts of the docgen tools to fix:

fix old, broken K8s links (was 1.17) to match the api version from go.mod
stop using the deprecated ast.Package type
better error handling (exit on error)
only one pass on the ast
use go-template instead of fmt.Print to generate the doc file

Release note

None

kubevirt-bot · 2024-12-09T13:41:30Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from nunnatsa. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

coveralls · 2024-12-09T13:50:11Z

Pull Request Test Coverage Report for Build 12468210166

Details

0 of 0 changed or added relevant lines in 0 files are covered.
3 unchanged lines in 1 file lost coverage.
Overall coverage decreased (-0.04%) to 71.751%

Files with Coverage Reduction	New Missed Lines	%
controllers/operands/operandHandler.go	3	86.14%

Totals
Change from base Build 12466906362:	-0.04%
Covered Lines:	6139
Relevant Lines:	8556

💛 - Coveralls

hco-bot · 2024-12-09T16:41:47Z

hco-e2e-operator-sdk-azure lane succeeded.
/override ci/prow/hco-e2e-operator-sdk-gcp

kubevirt-bot · 2024-12-09T16:41:51Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-operator-sdk-gcp

In response to this:

hco-e2e-operator-sdk-azure lane succeeded.
/override ci/prow/hco-e2e-operator-sdk-gcp

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

hco-bot · 2024-12-09T17:32:49Z

hco-e2e-upgrade-prev-operator-sdk-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-prev-operator-sdk-azure

kubevirt-bot · 2024-12-09T17:32:54Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-prev-operator-sdk-azure

In response to this:

hco-e2e-upgrade-prev-operator-sdk-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-prev-operator-sdk-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

hco-bot · 2024-12-09T18:15:50Z

hco-e2e-kv-smoke-gcp lane succeeded.
/override ci/prow/hco-e2e-kv-smoke-azure

kubevirt-bot · 2024-12-09T18:15:54Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-kv-smoke-azure

In response to this:

hco-e2e-kv-smoke-gcp lane succeeded.
/override ci/prow/hco-e2e-kv-smoke-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

nunnatsa · 2024-12-11T12:14:01Z

/retest

hco-bot · 2024-12-11T14:53:46Z

hco-e2e-upgrade-operator-sdk-sno-azure lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-sno-aws

kubevirt-bot · 2024-12-11T14:53:51Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-operator-sdk-sno-aws

In response to this:

hco-e2e-upgrade-operator-sdk-sno-azure lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-sno-aws

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

hco-bot · 2024-12-11T15:12:21Z

hco-e2e-upgrade-operator-sdk-azure lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-aws

kubevirt-bot · 2024-12-11T15:12:27Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-operator-sdk-aws

In response to this:

hco-e2e-upgrade-operator-sdk-azure lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-aws

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

hco-bot · 2024-12-15T12:19:33Z

hco-e2e-operator-sdk-gcp lane succeeded.
/override ci/prow/hco-e2e-operator-sdk-aws

kubevirt-bot · 2024-12-15T12:19:37Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-operator-sdk-aws

In response to this:

hco-e2e-operator-sdk-gcp lane succeeded.
/override ci/prow/hco-e2e-operator-sdk-aws

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

hco-bot · 2024-12-15T12:54:15Z

hco-e2e-operator-sdk-gcp lane succeeded.
/override ci/prow/hco-e2e-operator-sdk-azure
hco-e2e-upgrade-prev-operator-sdk-sno-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-azure

kubevirt-bot · 2024-12-15T12:54:24Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-operator-sdk-azure, ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-azure

In response to this:

hco-e2e-operator-sdk-gcp lane succeeded.
/override ci/prow/hco-e2e-operator-sdk-azure
hco-e2e-upgrade-prev-operator-sdk-sno-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

nunnatsa · 2024-12-16T13:00:06Z

/retest

hco-bot · 2024-12-16T15:12:17Z

hco-e2e-consecutive-operator-sdk-upgrades-aws lane succeeded.
/override ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure

kubevirt-bot · 2024-12-16T15:12:24Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure

In response to this:

hco-e2e-consecutive-operator-sdk-upgrades-aws lane succeeded.
/override ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

hco-bot · 2024-12-16T17:10:44Z

hco-e2e-consecutive-operator-sdk-upgrades-aws lane succeeded.
/override ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure

kubevirt-bot · 2024-12-16T17:10:51Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure

In response to this:

hco-e2e-consecutive-operator-sdk-upgrades-aws lane succeeded.
/override ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

nunnatsa · 2024-12-16T17:48:31Z

/retest

nunnatsa · 2024-12-17T04:06:59Z

/retest

hco-bot · 2024-12-17T05:52:29Z

hco-e2e-upgrade-operator-sdk-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-azure

kubevirt-bot · 2024-12-17T05:52:36Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-operator-sdk-azure

In response to this:

hco-e2e-upgrade-operator-sdk-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

hco-bot · 2024-12-17T06:42:30Z

hco-e2e-upgrade-operator-sdk-sno-azure lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-sno-aws

kubevirt-bot · 2024-12-17T06:42:38Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-operator-sdk-sno-aws

In response to this:

hco-e2e-upgrade-operator-sdk-sno-azure lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-sno-aws

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

orenc1 · 2024-12-17T20:13:40Z

tools/docgen/main.go

-		strukt := t[0]
-		if len(t) > 1 {
-			fmt.Printf("\n## %s\n\n%s\n\n", strukt.Name, strukt.Doc)
+	for _, strukt := range initial {


what does strukt mean?

It ast info about a struct. But struct is a reserved word, so strukt.

Have the relevant changes done by default, i.e adding the bindings. Signed-off-by: Or Shoval <[email protected]>

rewrite parts of the docgen tools to fix: * stop using the deprecated ast.Package type * better error handling (exit on error) * only one pass on the ast * renames in some cases * fix old K8s links (was 1.17) to match the api version from go.mod * use go-template instead of fmt.Print to generate the doc file Signed-off-by: Nahshon Unna-Tsameret <[email protected]>

sonarqubecloud · 2024-12-23T14:17:43Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

hco-bot · 2024-12-23T16:12:46Z

hco-e2e-upgrade-prev-operator-sdk-sno-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-azure
hco-e2e-upgrade-prev-operator-sdk-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-prev-operator-sdk-azure

kubevirt-bot · 2024-12-23T16:12:51Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-prev-operator-sdk-azure, ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-azure

In response to this:

hco-e2e-upgrade-prev-operator-sdk-sno-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-prev-operator-sdk-sno-azure
hco-e2e-upgrade-prev-operator-sdk-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-prev-operator-sdk-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

hco-bot · 2024-12-23T16:53:02Z

hco-e2e-consecutive-operator-sdk-upgrades-aws lane succeeded.
/override ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure

kubevirt-bot · 2024-12-23T16:53:05Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure

In response to this:

hco-e2e-consecutive-operator-sdk-upgrades-aws lane succeeded.
/override ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci · 2024-12-23T18:35:36Z

@nunnatsa: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/hco-e2e-consecutive-operator-sdk-upgrades-azure	`aeff4e0`	link	true	`/test hco-e2e-consecutive-operator-sdk-upgrades-azure`
ci/prow/hco-e2e-kv-smoke-azure	`aeff4e0`	link	true	`/test hco-e2e-kv-smoke-azure`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

hco-bot · 2024-12-23T18:35:59Z

hco-e2e-kv-smoke-gcp lane succeeded.
/override ci/prow/hco-e2e-kv-smoke-azure

kubevirt-bot · 2024-12-23T18:36:04Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-kv-smoke-azure

In response to this:

hco-e2e-kv-smoke-gcp lane succeeded.
/override ci/prow/hco-e2e-kv-smoke-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

nunnatsa · 2024-12-23T19:22:45Z

/retest

hco-bot · 2024-12-23T20:52:37Z

hco-e2e-upgrade-operator-sdk-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-azure

kubevirt-bot · 2024-12-23T20:52:42Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-operator-sdk-azure

In response to this:

hco-e2e-upgrade-operator-sdk-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

hco-bot · 2024-12-23T21:09:33Z

hco-e2e-upgrade-operator-sdk-sno-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-sno-azure

kubevirt-bot · 2024-12-23T21:09:38Z

@hco-bot: Overrode contexts on behalf of hco-bot: ci/prow/hco-e2e-upgrade-operator-sdk-sno-azure

In response to this:

hco-e2e-upgrade-operator-sdk-sno-aws lane succeeded.
/override ci/prow/hco-e2e-upgrade-operator-sdk-sno-azure

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

kubevirt-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. labels Dec 9, 2024

kubevirt-bot requested review from avlitman and machadovilaca December 9, 2024 13:41

kubevirt-bot added the size/XXL label Dec 9, 2024

nunnatsa force-pushed the fix-docgen branch from daf6c83 to a693b21 Compare December 9, 2024 14:01

nunnatsa force-pushed the fix-docgen branch from a693b21 to 503cab0 Compare December 15, 2024 10:48

kubevirt-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 15, 2024

nunnatsa force-pushed the fix-docgen branch from 503cab0 to b1fef3b Compare December 15, 2024 10:50

kubevirt-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 15, 2024

orenc1 reviewed Dec 17, 2024

View reviewed changes

kubevirt-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 23, 2024

oshoval and others added 2 commits December 23, 2024 16:16

Deprecate primaryUserDefinedNetworkBinding FG (kubevirt#3204)

513ba29

Have the relevant changes done by default, i.e adding the bindings. Signed-off-by: Or Shoval <[email protected]>

nunnatsa force-pushed the fix-docgen branch from b1fef3b to aeff4e0 Compare December 23, 2024 14:17

kubevirt-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 23, 2024

Fix the docgen tool #3199

Are you sure you want to change the base?

Fix the docgen tool #3199

Conversation

nunnatsa commented Dec 9, 2024 • edited Loading

What this PR does / why we need it

Release note

kubevirt-bot commented Dec 9, 2024

coveralls commented Dec 9, 2024 • edited Loading

Pull Request Test Coverage Report for Build 12468210166

Details

💛 - Coveralls

hco-bot commented Dec 9, 2024

kubevirt-bot commented Dec 9, 2024

hco-bot commented Dec 9, 2024

kubevirt-bot commented Dec 9, 2024

hco-bot commented Dec 9, 2024

kubevirt-bot commented Dec 9, 2024

nunnatsa commented Dec 11, 2024

hco-bot commented Dec 11, 2024

kubevirt-bot commented Dec 11, 2024

hco-bot commented Dec 11, 2024

kubevirt-bot commented Dec 11, 2024

hco-bot commented Dec 15, 2024

kubevirt-bot commented Dec 15, 2024

hco-bot commented Dec 15, 2024

kubevirt-bot commented Dec 15, 2024

nunnatsa commented Dec 16, 2024

hco-bot commented Dec 16, 2024

kubevirt-bot commented Dec 16, 2024

hco-bot commented Dec 16, 2024

kubevirt-bot commented Dec 16, 2024

nunnatsa commented Dec 16, 2024

nunnatsa commented Dec 17, 2024

hco-bot commented Dec 17, 2024

kubevirt-bot commented Dec 17, 2024

hco-bot commented Dec 17, 2024

kubevirt-bot commented Dec 17, 2024

orenc1 Dec 17, 2024

Choose a reason for hiding this comment

nunnatsa Dec 17, 2024

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 23, 2024

Quality Gate passed

hco-bot commented Dec 23, 2024

kubevirt-bot commented Dec 23, 2024

hco-bot commented Dec 23, 2024

kubevirt-bot commented Dec 23, 2024

openshift-ci bot commented Dec 23, 2024 • edited Loading

hco-bot commented Dec 23, 2024

kubevirt-bot commented Dec 23, 2024

nunnatsa commented Dec 23, 2024

hco-bot commented Dec 23, 2024

kubevirt-bot commented Dec 23, 2024

hco-bot commented Dec 23, 2024

kubevirt-bot commented Dec 23, 2024

nunnatsa commented Dec 9, 2024 •

edited

Loading

coveralls commented Dec 9, 2024 •

edited

Loading

openshift-ci bot commented Dec 23, 2024 •

edited

Loading