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

[builder] add doc generation #12528

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

atoulme
Copy link
Contributor

@atoulme atoulme commented Feb 28, 2025

Description

Adds a go script that you can run manually as part of the distribution to output documentation.

The script takes an optional argument pointing to a go text template file. If no argument is given, the script will use the default md.tmpl file to generate a set of markdown tables for each component categories.

@atoulme atoulme requested a review from a team as a code owner February 28, 2025 16:41
@atoulme atoulme requested a review from codeboten February 28, 2025 16:41
@atoulme atoulme force-pushed the generate_docs branch 2 times, most recently from 01998a7 to 55f3b10 Compare February 28, 2025 16:42
Copy link

codecov bot commented Feb 28, 2025

Codecov Report

Attention: Patch coverage is 26.66667% with 11 lines in your changes missing coverage. Please review.

Project coverage is 91.96%. Comparing base (0faea29) to head (3463d5f).
Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
cmd/builder/internal/builder/main.go 0.00% 10 Missing and 1 partial ⚠️

❌ Your patch check has failed because the patch coverage (26.66%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12528      +/-   ##
==========================================
- Coverage   92.00%   91.96%   -0.04%     
==========================================
  Files         469      469              
  Lines       25355    25370      +15     
==========================================
+ Hits        23327    23331       +4     
- Misses       1619     1629      +10     
- Partials      409      410       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

1 participant