Skip to content
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

Merged
merged 10 commits into from
Apr 2, 2019
Merged

feat: also generate samples/README.md #214

merged 10 commits into from
Apr 2, 2019

Conversation

bcoe
Copy link
Contributor

@bcoe bcoe commented Mar 27, 2019

similar to the work with ./README.md, synthtool will now regenerate samples/README.md as changes are made to the samples directory.

@bcoe bcoe requested review from jkwlui and busunkim96 March 27, 2019 23:39
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Mar 27, 2019
Copy link
Contributor Author

@bcoe bcoe left a 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/

@@ -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")
Copy link
Contributor Author

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

Copy link
Contributor Author

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.

Copy link
Contributor

@JustinBeckwith JustinBeckwith left a 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`."
Copy link
Contributor

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 <bencoe@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants