Skip to content
This repository has been archived by the owner on Jun 28, 2022. It is now read-only.

[SampleGen] 🚀 Enable Google Cloud client library repo support #2954

Closed
1 of 3 tasks
beccasaurus opened this issue Aug 28, 2019 · 1 comment
Closed
1 of 3 tasks
Assignees
Labels
Core: Sample-gen type: process A process-related concern. May include testing, release, or the like.

Comments

@beccasaurus
Copy link
Contributor

beccasaurus commented Aug 28, 2019

🚀 Enable SampleGen functionality for client library repos

» Tracking issue 🐞

Now that gapic-generator supports generating code samples in C#, Go, Java, Node.js, PHP, Python, and Ruby, each of the respective client library repositories should enable support for generated code samples so that autosynth distributes generated samples for publication.


🖋 Sample Authoring [Journey] – (same journey as making library config changes)

  • googleapis is updated – (with new sample and/or test configs)
  • autosynth triggers synthtool – (results in new/updated sample/test files being generated)
  • autosynth creates a Pull Request – (b/c generator output changed including sample/test files)
  • Pull Request runs sample tests – (requires running $ sample-tester)
  • That's all!

📝 Two changes are required in client library repos to enable support for generated samples:

  1. Update the CI / test scripts to run sample tests (*.test.yaml) using $sample-tester

  2. On a per-API per-Library basis, each synth.py needs to be updated to generate samples
    (intentionally manual process to enable; enabling requires setting include_samples=True)

This issue tracks #1 – Enable CI / test scripts to run sample tests (for each language / API)


Status / Blocking Issues

In Review

Upcoming (issues not yet filed against library repos)

  • 🐹 Go
  • 🚀 Node.js
  • ☕️ Java
  • #️⃣ C# / .NET

(... I'll fill in the above with links as they become available ...)


go/library-samples (internal)

@googleapis/samplegen

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Core: Sample-gen type: process A process-related concern. May include testing, release, or the like.
Projects
None yet
Development

No branches or pull requests

2 participants