feat(generate): add Services section to generated project README - #2934
Open
mikeland73 wants to merge 1 commit into
Open
feat(generate): add Services section to generated project README#2934mikeland73 wants to merge 1 commit into
mikeland73 wants to merge 1 commit into
Conversation
`devbox generate readme` documented scripts, packages, environment variables, and the shell init hook, but never mentioned services. This made services less discoverable in a project's generated README even though they are a first-class part of a Devbox environment. Add a Services section to the generated README that lists each service (from the project's plugins and its process-compose.yaml) and documents how to start, stop, and list them. The section is omitted when the project defines no services. Fixes #2626 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Qgu2wVkmAdXLRKcpgevoBW
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #2626.
devbox generate readmeproduces a project README that documents theproject's scripts, packages, environment variables, and shell init
hook — but it never mentioned services. As the issue reporter points out,
services are as central to a Devbox environment as scripts and packages, so
their absence from the generated README both hid a useful feature and left
readers unaware that services exist at all.
This PR adds a Services section to the generated README, mirroring how
Scripts are documented:
way the rest of the CLI gathers them — via
Devbox.Services(), which combinesplugin-provided services with any defined in the project's
process-compose.yaml.devbox services up), stop (devbox services stop),and list (
devbox services ls) services, including targeting an individualservice by name.
template guards it with
{{- if .Services }}), so existing service-lessprojects generate an unchanged README.
Changes
internal/devbox/docgen/docgen.go— pass the project's services into thetemplate data (propagating any error from
Devbox.Services()).internal/devbox/docgen/readme.tmpl— render the new Services section.testscripts/generate/readme.test.txt— new testscript that defines twoservices via a project
process-compose.yaml, runsdevbox generate readme,and asserts the generated README lists both services and documents how to
start/stop them.
How was it tested?
testscripts/generate/readme.test.txtcovering the new behavior end toend (
devbox init→devbox generate readme→ assert the Services section andservice names are present).
readme.tmpldirectly against a sample data map (with and withoutservices) to confirm the Services section appears when services are present,
is omitted when they are absent, and that all other sections are unchanged.
go build ./...,go vet ./internal/devbox/docgen/, andgofmtare clean onthe changed files.
cc @ametad (issue reporter) — thanks for the suggestion!
Community Contribution License
All community contributions in this pull request are licensed to the project
maintainers under the terms of the
Apache 2 License.
By creating this pull request, I represent that I have the right to license the
contributions to the project maintainers under the Apache 2 License as stated in
the
Community Contribution License.
🤖 Generated with Claude Code
https://claude.ai/code/session_01Qgu2wVkmAdXLRKcpgevoBW
Generated by Claude Code