Auto-generate config docs from code
Nobody has claimed this yet.
- #4292 by @lookharm — closed without merging
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- go
- Domain
- build-system, documentation, tooling
Research direction
Start by comparing cmd/buildkitd/config/config.go with docs/buildkitd.toml.md, then review PRs 4273 and 3773 to understand the documented drift. Define how doc-comments and types should produce the relevant configuration documentation; done means the generated output covers the config fields and prevents the two sources from diverging.
Written by the indexing model from the issue text.
Description
The definition for the buildkit.toml format lives in https://github.com/moby/buildkit/blob/0f6482e34cec2d25c4397b812e442e1c8eea06d0/cmd/buildkitd/config/config.go
The fields are all documented in https://github.com/moby/buildkit/blob/0f6482e34cec2d25c4397b812e442e1c8eea06d0/docs/buildkitd.toml.md.
However, these can be out-of-date, which means sometimes we get drift - see https://github.com/moby/buildkit/pull/4273, which should have been updated as part of https://github.com/moby/buildkit/pull/3773, but got missed.
Ideally, we should auto-generate part of the buildkit docs using the code, by extracting doc-comments, and analyzing the types.
(cc @dvdksn)
- Dominant language
- Go
- Stars
- 10.3k
- Forks
- 1.5k
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 48
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from moby/buildkit
-
status/triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
area/dockerfile
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Similar issues
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
blinklabs-io/bursa#904 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
yanet-platform/ipfw-go#129 ·
-
bug confmap/provider/googlesecretmanagerprovider needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
open-telemetry/opentelemetry-collector-contrib#51273 · 2 comments ·
-
bug: AI Gateway client filter lists "Unknown" twice when NULL and literal Unknown clients coexist Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100