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

docs: regenerate the samples/README.md #649

Merged
merged 7 commits into from
Apr 4, 2019
Merged

Conversation

bcoe
Copy link
Contributor

@bcoe bcoe commented Mar 27, 2019

Fixes: googleapis/google-cloud-node#2868 we can now magically auto-generate both README.md and samples/README.md (this will become all the more powerful with discussions around auto-generating .repo-metadata.json (CC: @busunkim96, @jmdobry).

This pull request:

  • switches to generated samples/README.md (this file is a slight simplification, no longer rendering the yargs CLI output, which is being removed from newer samples any ways).
  • removes generate-scaffolding from the package.json (as it's now not used by anything).

Related: googleapis/synthtool#214

  • Tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Mar 27, 2019
@codecov
Copy link

codecov bot commented Mar 28, 2019

Codecov Report

Merging #649 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #649      +/-   ##
==========================================
+ Coverage   97.92%   97.94%   +0.01%     
==========================================
  Files           9        9              
  Lines         869      874       +5     
  Branches       99       99              
==========================================
+ Hits          851      856       +5     
  Misses          9        9              
  Partials        9        9
Impacted Files Coverage Δ
src/notification.ts 100% <0%> (ø) ⬆️
src/channel.ts 100% <0%> (ø) ⬆️
src/file.ts 98.64% <0%> (ø) ⬆️
src/bucket.ts 95.75% <0%> (+0.01%) ⬆️
src/storage.ts 98.36% <0%> (+0.02%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c0db858...ccc81c3. Read the comment docs.

samples/README.md Show resolved Hide resolved
samples/README.md Show resolved Hide resolved

## Before you begin

Before running the samples, make sure you've followed the steps in the
[Before you begin section](../README.md#before-you-begin) of the client
[Using the client library](https://github.com/googleapis/nodejs-storage#using-the-client-library) of the client
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't read very well. Maybe it should be quoted around the link, and we can probably remove all the "client library" phrasing. Maybe "...make sure you've followed these steps."

@JustinBeckwith
Copy link
Contributor

@bcoe can we land this?

@JustinBeckwith JustinBeckwith merged commit 00d61bc into master Apr 4, 2019
@bcoe bcoe deleted the new-samples-readme branch April 4, 2019 17:32
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. 🚨 This issue needs some love.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants