From fc1b468ef0178bebe47782e69577372bc47e05be Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 22 Jul 2021 13:48:38 +0000 Subject: [PATCH] feat: add Samples section to CONTRIBUTING.rst (#235) Source-Link: https://github.com/googleapis/synthtool/commit/52e4e46eff2a0b70e3ff5506a02929d089d077d4 Post-Processor: gcr.io/repo-automation-bots/owlbot-python:latest@sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605 --- .../.github/.OwlBot.lock.yaml | 4 +--- packages/google-cloud-asset/CONTRIBUTING.rst | 24 +++++++++++++++++++ .../samples/snippets/noxfile.py | 5 ++-- 3 files changed, 28 insertions(+), 5 deletions(-) diff --git a/packages/google-cloud-asset/.github/.OwlBot.lock.yaml b/packages/google-cloud-asset/.github/.OwlBot.lock.yaml index edd21dadc549..d57f74204625 100644 --- a/packages/google-cloud-asset/.github/.OwlBot.lock.yaml +++ b/packages/google-cloud-asset/.github/.OwlBot.lock.yaml @@ -1,5 +1,3 @@ docker: image: gcr.io/repo-automation-bots/owlbot-python:latest - digest: sha256:5ff7446edeaede81c3ed58b23a4e76a5403fba1350ce28478045657303b6479d - - + digest: sha256:6186535cbdbf6b9fe61f00294929221d060634dae4a0795c1cefdbc995b2d605 diff --git a/packages/google-cloud-asset/CONTRIBUTING.rst b/packages/google-cloud-asset/CONTRIBUTING.rst index f1fece124f87..889f55210806 100644 --- a/packages/google-cloud-asset/CONTRIBUTING.rst +++ b/packages/google-cloud-asset/CONTRIBUTING.rst @@ -177,6 +177,30 @@ Build the docs via: $ nox -s docs +************************* +Samples and code snippets +************************* + +Code samples and snippets live in the `samples/` catalogue. Feel free to +provide more examples, but make sure to write tests for those examples. +Each folder containing example code requires its own `noxfile.py` script +which automates testing. If you decide to create a new folder, you can +base it on the `samples/snippets` folder (providing `noxfile.py` and +the requirements files). + +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:: + + # Run all tests in a folder + $ cd samples/snippets + $ nox -s py-3.8 + + # Run a single sample test + $ cd samples/snippets + $ nox -s py-3.8 -- -k + ******************************************** Note About ``README`` as it pertains to PyPI ******************************************** diff --git a/packages/google-cloud-asset/samples/snippets/noxfile.py b/packages/google-cloud-asset/samples/snippets/noxfile.py index 5ff9e1db5808..6a8ccdae22c9 100644 --- a/packages/google-cloud-asset/samples/snippets/noxfile.py +++ b/packages/google-cloud-asset/samples/snippets/noxfile.py @@ -28,8 +28,9 @@ # WARNING - WARNING - WARNING - WARNING - WARNING # WARNING - WARNING - WARNING - WARNING - WARNING -# Copy `noxfile_config.py` to your directory and modify it instead. +BLACK_VERSION = "black==19.10b0" +# Copy `noxfile_config.py` to your directory and modify it instead. # `TEST_CONFIG` dict is a configuration hook that allows users to # modify the test configurations. The values here should be in sync @@ -159,7 +160,7 @@ def lint(session: nox.sessions.Session) -> None: @nox.session def blacken(session: nox.sessions.Session) -> None: - session.install("black") + session.install(BLACK_VERSION) python_files = [path for path in os.listdir(".") if path.endswith(".py")] session.run("black", *python_files)