-
Notifications
You must be signed in to change notification settings - Fork 90
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
feat: also generate samples/README.md #214
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
phew, this was a tiny bit more work than I expected, but I think we're in a position to start regenerating a bunch of Node.js README.md files \o/
synthtool/gcp/common.py
Outdated
@@ -57,6 +57,7 @@ def node_library(self, **kwargs) -> Path: | |||
# .repo-metadata.json, or excluding README.md, we can remove this. | |||
if not os.path.exists("./.repo-metadata.json"): | |||
self.excludes.append("README.md") | |||
self.excludes.append("samples/README.md") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we don't want to generate the new README until we've plopped a .repo-metadata.json
in the folder, otherwise we get a junk file.
* [{{ sample.name }}](#{{ sample.name|slugify }}){% endfor %}{% endif %} | ||
|
||
## Before you begin | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this README has been simplified, the need for executing samples to generate yargs
output, this matches the direction we're moving in for samples any ways.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM w/ nit. It's always hard to know how this will go until we run it on a few repositories, but this is a good start.
@@ -0,0 +1,51 @@ | |||
[//]: # "This README.md file is auto-generated, all changes to this file will be lost." | |||
[//]: # "To regenerate it, use `npm run generate-scaffolding`." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't think we want npm run generate-scaffolding
Co-Authored-By: bcoe <[email protected]>
similar to the work with
./README.md
,synthtool
will now regeneratesamples/README.md
as changes are made to the samples directory.