-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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
Stripping the release tarballs #5618
Comments
yes for cleaning more, not so much for a separate readme because of the extremely low visibility it'll have for all of us which will lead to an increased likelihood that it'll quickly become stale and outdated |
+1 clean more |
+1 on cleaning things up. Agree with @rvagg's comments on the readme... I'd just leave that one as is. |
Instead of an alternate It seems to me that the build instructions dominate the CLARIFICATION: So instead of stripping build stuff out of an alternate README, strip it out of the canonical README and have the build instructions live in its own document. So we still only have one README and one place where build instructions live. |
PR here: #5695 |
(refs #5612)
I think we should be a bit more aggressive as to what we bundle in the release tarballs. I see it similar to how autotools handles
make dist
versus using the original repo; meaning most files there for specific development won't be included - but enough files to verify the state of the binary often is (read: test suite). With this strategy most dotfiles, readme's in the root directory would go away. Additionally, I'd suggest stripping everything related to linting and introduce some minor logic inMakefile
/vcbuild.bat
that points people togit clone
if they want to do development. Theres probably a few more things intools/
we could strip, such as packagemaker-stuff.Finally, @bnoordhuis suggested we bake an alternate readme that we push as part of the release packages that more accurately represents whats included and how to use it.
Thoughts? Anything else that should go?
cc: @nodejs/build, @bnoordhuis, @Trott, @jasnell
The text was updated successfully, but these errors were encountered: