8000 Updated config reference docs generation by applejag · Pull Request #160 · kubecolor/kubecolor · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Updated config reference docs generation #160

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

Merged
merged 1 commit into from
Aug 21, 2024
Merged

Conversation

applejag
Copy link
Member

Description

Changed (and bugfixed) the configdoc script.

Type of change

Changes

  • Added tabwriter to YAML printer to make comments line up with each other
  • Fixed some fields having wrong naming (e.g durationfresh -> durationFresh, dryrun -> dryRun). The naming implementation was copied from the JSON schema generator's naming function.

Motivation

The tabwriter makes it more readable, and the naming fixes makes it match up with the JSON schema.

Viper (the config library) doesn't care about casing in YAML fields, so using all lowercase still works

@applejag applejag added the chore Routine task, refactoring, or other changes not affecting end-users directly. label Aug 13, 2024
@applejag applejag self-assigned this Aug 13, 2024
@applejag applejag requested a review from prune998 August 13, 2024 16:06
Copy link
codecov bot commented Aug 13, 2024

Codecov Report

Attention: Patch coverage is 0% with 26 lines in your changes missing coverage. Please review.

Project coverage is 52.51%. Comparing base (d002b6d) to head (dc75a5e).
Report is 3 commits behind head on main.

Files Patch % Lines
internal/cmd/configdoc/print_yaml.go 0.00% 26 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #160      +/-   ##
==========================================
- Coverage   52.78%   52.51%   -0.27%     
==========================================
  Files          53       53              
  Lines        3698     3717      +19     
==========================================
  Hits         1952     1952              
- Misses       1626     1645      +19     
  Partials      120      120              

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

@prune998 prune998 merged commit 722d6de into main Aug 21, 2024
7 of 9 checks passed
@prune998 prune998 deleted the chore/update-configdoc-gen branch August 21, 2024 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Routine task, refactoring, or other changes not affecting end-users directly.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0