[gen-readme] For generated readme scripts, replace absolute paths #1949
Conversation
This file contains 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
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
Plugins v2 allow scripts that may have
VirtenvorDevboxDirin them. This causes the commands to show up as absolute paths in the readme. This fixes that issue.An alternative is to read the raw scripts from the plugin (including the un-templatized string). This may be a better solution long term, but is more work and would require specially plugin parsing only for the readme generation so I punted on that approach for now.
How was it tested?
Tested with new go monorepo plugin jetify-com/devbox-plugins#7