Skip to content
This repository was archived by the owner on Apr 1, 2026. It is now read-only.

docs: add Samples section to CONTRIBUTING.rst - #380

Closed
gcf-owl-bot[bot] wants to merge 2 commits into
masterfrom
owl-bot-update-lock-6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605
Closed

docs: add Samples section to CONTRIBUTING.rst#380
gcf-owl-bot[bot] wants to merge 2 commits into
masterfrom
owl-bot-update-lock-6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605

Conversation

@gcf-owl-bot

Copy link
Copy Markdown
Contributor

Source-Link: googleapis/synthtool@52e4e46
Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605

Source-Link: googleapis/synthtool@52e4e46
Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605
@gcf-owl-bot
gcf-owl-botBot requested review from a teamJuly 20, 2021 09:13
@trusted-contributions-gcftrusted-contributions-gcfBot added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Jul 20, 2021
@product-auto-labelproduct-auto-labelBot added the api: bigtable Issues related to the googleapis/python-bigtable API. label Jul 20, 2021
@google-clagoogle-claBot added the cla: yes This human has signed the Contributor License Agreement. label Jul 20, 2021
@yoshi-kokoroyoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 20, 2021
@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 20, 2021
@partheaparthea added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jul 20, 2021
@tseaver

Copy link
Copy Markdown
Contributor

Sample failure reported in #383, addressed in PR #384.

Comment threadCONTRIBUTING.rst
The tests will run against a real Google Cloud Project, so you should
configure them just like the System Tests.

- To run sample tests, you can execute::

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This seems explicit, but this is a single sort of sample. There are many in bigtable. When I read this it sort of reads like the only samples are samples/snippets.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

cc: @busunkim96@parthea is this unique to bigtable (having so many other directories in samples)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • python-spanner has one directory of samples, oddly enough nested under samples/samples. Logically they could be broken up, rooted at just samples/, but that would break docs.
  • python-bigquery has an odd mix: lots of samples in just samples/, but the test drivers are in samples/tests/, and the snippets are samples/snippets/, along with their test drivers.
  • python-pubsub only has runnable samples in samples/snippets/, including their test drivers.
  • python-storage has no samples.

The generated libraries have, interestingly, almost as wide a range.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In BigQuery, the goal is to have samples that just require the google-cloud-bigquery library in samples/snippets, but with other directories like samples/geography and sample/pandas for samples that have extra dependencies.

Just filed googleapis/python-bigquery#790 to actually document this goal.

@crwilcoxcrwilcox added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 20, 2021
@yoshi-kokoroyoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jul 20, 2021
@partheaparthea removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jul 21, 2021
@partheaparthea added the automerge Merge the pull request once unit tests and other checks pass. label Jul 22, 2021
@partheaparthea added kokoro:force-run Add this label to force Kokoro to re-run the tests. kokoro:run Add this label to force Kokoro to re-run the tests. labels Jul 22, 2021
@yoshi-kokoroyoshi-kokoro removed kokoro:run Add this label to force Kokoro to re-run the tests. kokoro:force-run Add this label to force Kokoro to re-run the tests. labels Jul 22, 2021
@tseavertseaver changed the title feat: add Samples section to CONTRIBUTING.rstdocs: add Samples section to CONTRIBUTING.rstJul 22, 2021
@tseavertseaver removed the automerge Merge the pull request once unit tests and other checks pass. label Jul 22, 2021
@tseaver

Copy link
Copy Markdown
Contributor

@parthea Please don't automerge -- we need to ensure that the squash merge commit uses docs: prefix.

@partheaparthea added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jul 23, 2021
@trusted-contributions-gcftrusted-contributions-gcfBot added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Jul 23, 2021
@partheaparthea closed this Jul 23, 2021
@parthea

Copy link
Copy Markdown
Contributor

Superseded by #396

@gcf-owl-botgcf-owl-botBot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 23, 2021
@tseaver
tseaver deleted the owl-bot-update-lock-6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605 branch September 22, 2021 20:17
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api: bigtableIssues related to the googleapis/python-bigtable API.cla: yesThis human has signed the Contributor License Agreement.do not mergeIndicates a pull request not ready for merge, due to either quality or timing.kokoro:force-runAdd this label to force Kokoro to re-run the tests.owl-bot-update-lock

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@tseaver@parthea@tswast@crwilcox@yoshi-kokoro