docs: add a note in pkg_tar#strip_prefix docs (v.0.8.0) about flattening #699
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
jhchabran
changed the title
|
It would be more useful to correct the text in the code and regenerate the docs. |
jhchabran
force-pushed
the
8.0-docs-note-about-strip_prefix
branch
from
0473234 to
5dddacc
Compare
jhchabran
force-pushed
the
8.0-docs-note-about-strip_prefix
branch
from
5dddacc to
aea720b
Compare
|
@aiuto updated :) |
aiuto
approved these changes
Jun 5, 2023
|
Going to try to merge and then I will fix tests after. |
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.
Hey folks, here is a very inconsequential PR which could save some time to new users.
From the perspective of someone who just started using
rules_pkg, I was really confused to learn that if I don't want to flatten the files structure I have to use the undocumentedstrip_prefix = "."magic trick.While there is an ongoing discussion over #354 on this precise issue, I feel that it would save a lot a time for new users stumbling across this problem by having a quick note in the existing docs, while the conversation continues over there.