Remove non-code files from release archive #25
Merged
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
how is this created? the literal releases that are generated? if so, we should make it clear somewhere, like the README, that the release doesn't include these things. otherwise, folks may download the latest release, hoping to try out the example, and get confused about why it's not there. |
|
@cyle Good point: I updated the documentation to mention that. |
cyle
reviewed
Sep 25, 2023
| @@ -54,7 +54,7 @@ As an example of how to use StreamBuilder, we will implement an endpoint to retr | |||
|
|
|||
| Let's also assume the returned array is a simple `string[]` which contains trending topics as strings. | |||
|
|
|||
| We also have an example demo application in the `example/` folder which implements a lot of what we're going to discuss here -- so check that out! | |||
| We also have an example demo application in the `example/` folder which implements a lot of what we're going to discuss here -- so check that out! You must clone the Git repository to work with the example, as released archives do not include example code. | |||
There was a problem hiding this comment.
awesome. mind adding this somewhere prominent in the example/README.md file as well?
cyle
approved these changes
Sep 26, 2023
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.
See: #24
What and why? 🤔
To avoid problems such as in #24 let's exclude all non-library files (examples, tests, plumbing) from the final release archive.
Testing Steps ✍️
git archive --format=tar HEAD | tar tshould get you a list of included files, which should not include tests and examples.For a summary, see:
You're it! 👑
@Automattic/stream-builders