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

add configuration field inline docs #430

Merged
merged 3 commits into from
May 11, 2023

Conversation

joshrwolf
Copy link
Contributor

@joshrwolf joshrwolf commented May 8, 2023

add struct field inline docs for configuration structs, for use (eventually) by some external docs parser like the one here

@joshrwolf joshrwolf requested a review from a team as a code owner May 8, 2023 14:39
@joshrwolf joshrwolf requested review from jonjohnsonjr and removed request for a team May 8, 2023 14:39
@joshrwolf joshrwolf force-pushed the docs-and-json branch 5 times, most recently from e18f9b4 to 8144663 Compare May 8, 2023 15:00
Signed-off-by: Josh Wolf <josh@wolfs.io>
@joshrwolf joshrwolf changed the title use json field tags and add field docs add configuration field docs May 8, 2023
@joshrwolf joshrwolf changed the title add configuration field docs add configuration field inline docs May 8, 2023
luhring
luhring previously approved these changes May 9, 2023
Copy link
Contributor

@luhring luhring left a comment

Choose a reason for hiding this comment

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

This is amazing to have!! Thanks for raising the bar for us!

pkg/build/build.go Outdated Show resolved Hide resolved
pkg/build/build.go Outdated Show resolved Hide resolved
Comment on lines +284 to +288
// Optional: The map of security fixes for this package keyed by the version
// found
Secfixes Secfixes `yaml:"secfixes,omitempty"`
// Optional: The map of advisories for this package
Advisories Advisories `yaml:"advisories,omitempty"`
Copy link
Contributor

Choose a reason for hiding this comment

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

No change requested, just mentioning in case it impacts your plans at all: we'll be these fields soon, along with the related secfixes/advisory types below.

Signed-off-by: Josh Wolf <josh@wolfs.io>
@joshrwolf joshrwolf enabled auto-merge May 11, 2023 20:12
@joshrwolf joshrwolf merged commit 88adada into chainguard-dev:main May 11, 2023
10 checks passed
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.

None yet

2 participants