Skip to content

ENH: refactor ctl/docs generation #1425

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Flying-Tom
Copy link
Contributor

@Flying-Tom Flying-Tom commented May 26, 2025

What type of PR is this?

/kind enhancement

What this PR does / why we need it:

main in both gen.go and main.go, which will cause a gopls problem main redeclared in this block.

Refactor ctl/docs generation to erase some lint error and add syntax highlight for codeblocks.

Which issue(s) this PR fixes:
Fixes #1264

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@Copilot Copilot AI review requested due to automatic review settings May 26, 2025 12:03
@kmesh-bot kmesh-bot added the kind/enhancement New feature or request label May 26, 2025
@kmesh-bot
Copy link
Collaborator

[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 assign nlgwcy for approval. 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:

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

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Scripts for generating kmeshctl documentation are updated to point to the new location of gen.go under the ctl/doc directory.

  • Changed working directory in the docgen script to match the new gen.go location.

Copy link

codecov bot commented May 26, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 46.27%. Comparing base (10e8eb3) to head (5ba9295).
Report is 25 commits behind head on main.

see 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1fd6d19...5ba9295. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Flying-Tom Flying-Tom changed the title Fix: move gen.go to avoid redeclared main ENH: refactor ctl/docs generation May 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generating markdown and html docs from the comments in go files
2 participants