Skip to content

[gen readme] Implement gen readme command #1728

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 2 commits into from
Jan 18, 2024
Merged

Conversation

mikeland73
Copy link
Contributor

@mikeland73 mikeland73 commented Jan 12, 2024

Summary

Implements devbox gen readme [filename] command. See devbox.md for what the output looks like.

Highlights:

  • Adds scripts with local links
  • Comments in devbox.json scripts are added to readme. (Limited support for these. Comments after script name and before script value are supported)
  • Adds packages and links to URL (nixhub or github)
  • Adds comment indicating generated by devbox. This comment can be used to insert readme into an existing readme.

How was it tested?

devbox gen readme devbox.md

@mikeland73
Copy link
Contributor Author

@gcurtis @loreto PTAL

This PR is not urgent, but don't want it to get stale.

Copy link
Contributor

@loreto loreto left a comment

Choose a reason for hiding this comment

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

LGTM

@mikeland73 mikeland73 merged commit ce61511 into main Jan 18, 2024
@mikeland73 mikeland73 deleted the landau/readme-autogen branch January 18, 2024 20:29
Copy link

sentry-io bot commented Jan 25, 2024

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

  • ‼️ **Generic Error: <redacted *errors.withStack>: <redacted errors.withStack>: <redacted fmt.wrapError>: <redacted ... go.jetpack.io/devbox/internal/devbox in Open View Issue

Did you find this useful? React with a 👍 or 👎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants