Skip to content

Commit 7011a12

Browse files
tswasttswast
authored
chore: add templated GitHub config files (#12)
Pulled manually from https://github.com/googleapis/synthtool/tree/master/synthtool/gcp/templates/python_library/.github Change-Id: I7f36912dffb427af2cd388abb8109670ac162701
1 parent 89b9503 commit 7011a12

18 files changed

+376
-0
lines changed

‎.github/CODEOWNERS

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Code owners file.
2+
# This file controls who is tagged for review for any given pull request.
3+
#
4+
# For syntax help see:
5+
# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
6+
# Note: This file is autogenerated. To make changes to the codeowner team, please update .repo-metadata.json.
7+
# @googleapis/yoshi-python @googleapis/api-bigquery-dataframe are the default owners for changes in this repo
8+
* @googleapis/yoshi-python @googleapis/api-bigquery-dataframe
9+
10+
# @googleapis/python-samples-reviewers @googleapis/api-bigquery-dataframe are the default owners for samples changes
11+
/samples/ @googleapis/python-samples-reviewers @googleapis/api-bigquery-dataframe

‎.github/CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# How to Contribute
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## Contributor License Agreement
7+
8+
Contributions to this project must be accompanied by a Contributor License
9+
Agreement. You (or your employer) retain the copyright to your contribution;
10+
this simply gives us permission to use and redistribute your contributions as
11+
part of the project. Head over to <https://cla.developers.google.com/> to see
12+
your current agreements on file or to sign a new one.
13+
14+
You generally only need to submit a CLA once, so if you've already submitted one
15+
(even if it was for a different project), you probably don't need to do it
16+
again.
17+
18+
## Code reviews
19+
20+
All submissions, including submissions by project members, require review. We
21+
use GitHub pull requests for this purpose. Consult
22+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23+
information on using pull requests.
24+
25+
## Community Guidelines
26+
27+
This project follows [Google's Open Source Community
28+
Guidelines](https://opensource.google.com/conduct/).

‎.github/ISSUE_TEMPLATE/bug_report.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
Thanks for stopping by to let us know something could be better!
8+
9+
**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.
10+
11+
Please run down the following list and make sure you've tried the usual "quick fixes":
12+
13+
- Search the issues already opened: https://github.com/googleapis/python-bigquery-dataframes/issues
14+
- Search StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-platform+python
15+
16+
If you are still having issues, please be sure to include as much information as possible:
17+
18+
#### Environment details
19+
20+
- OS type and version:
21+
- Python version: `python --version`
22+
- pip version: `pip --version`
23+
- `bigframes` version: `pip show bigframes`
24+
25+
#### Steps to reproduce
26+
27+
1. ?
28+
2. ?
29+
30+
#### Code example
31+
32+
```python
33+
# example
34+
```
35+
36+
#### Stack trace
37+
```
38+
# example
39+
```
40+
41+
Making sure to follow these steps will guarantee the quickest resolution possible.
42+
43+
Thanks!

‎.github/ISSUE_TEMPLATE/feature_request.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this library
4+
5+
---
6+
7+
Thanks for stopping by to let us know something could be better!
8+
9+
**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.
10+
11+
**Is your feature request related to a problem? Please describe.**
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
**Additional context**
18+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/support_request.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Support request
3+
about: If you have a support contract with Google, please create an issue in the Google Cloud Support console.
4+
5+
---
6+
7+
**PLEASE READ**: If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/) instead of filing on GitHub. This will ensure a timely response.

‎.github/PULL_REQUEST_TEMPLATE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
2+
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
3+
- [ ] Ensure the tests and linter pass
4+
- [ ] Code coverage does not decrease (if any source code was changed)
5+
- [ ] Appropriate docs were updated (if necessary)
6+
7+
Fixes #<issue_number_goes_here> 🦕

‎.github/auto-approve.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# https://github.com/googleapis/repo-automation-bots/tree/main/packages/auto-approve
2+
processes:
3+
- "OwlBotTemplateChanges"

‎.github/auto-label.yaml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Copyright 2023 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
requestsize:
15+
enabled: true

‎.github/header-checker-lint.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{"allowedCopyrightHolders": ["Google LLC"],
2+
"allowedLicenses": ["Apache-2.0", "MIT", "BSD-3"],
3+
"ignoreFiles": ["**/requirements.txt", "**/requirements-test.txt", "**/__init__.py", "samples/**/constraints.txt", "samples/**/constraints-test.txt"],
4+
"sourceFileExtensions": [
5+
"ts",
6+
"js",
7+
"java",
8+
"sh",
9+
"Dockerfile",
10+
"yaml",
11+
"py",
12+
"html",
13+
"txt"
14+
]
15+
}

‎.github/release-please.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
releaseType: python
2+
handleGHRelease: true

‎.github/release-trigger.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
enabled: true

‎.github/snippet-bot.yml

Whitespace-only changes.

‎.github/sync-repo-settings.yaml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# https://github.com/googleapis/repo-automation-bots/tree/main/packages/sync-repo-settings
2+
# Rules for main branch protection
3+
branchProtectionRules:
4+
# Identifies the protection rule pattern. Name of the branch to be protected.
5+
# Defaults to `main`
6+
- pattern: main
7+
requiresCodeOwnerReviews: true
8+
requiresStrictStatusChecks: true
9+
requiredStatusCheckContexts:
10+
- 'cla/google'
11+
- 'OwlBot Post Processor'
12+
- 'docs'
13+
- 'lint'
14+
- 'unit (3.9)'
15+
- 'unit (3.10)'
16+
- 'unit (3.11)'
17+
- 'cover'
18+
# TODO(tswast): add Kokoro once we've enabled it
19+
permissionRules:
20+
- team: actools-python
21+
permission: admin
22+
- team: actools
23+
permission: admin
24+
- team: api-bigquery-dataframe
25+
permission: push
26+
- team: yoshi-python
27+
permission: push
28+
- team: python-samples-owners
29+
permission: push
30+
- team: python-samples-reviewers
31+
permission: push

‎.github/workflows/docs.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
on:
2+
pull_request:
3+
branches:
4+
- main
5+
name: docs
6+
jobs:
7+
docs:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v3
12+
- name: Setup Python
13+
uses: actions/setup-python@v4
14+
with:
15+
python-version: "3.9"
16+
- name: Install nox
17+
run: |
18+
python -m pip install --upgrade setuptools pip wheel
19+
python -m pip install nox
20+
- name: Run docs
21+
run: |
22+
nox -s docs
23+
docfx:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v3
28+
- name: Setup Python
29+
uses: actions/setup-python@v4
30+
with:
31+
python-version: "3.9"
32+
- name: Install nox
33+
run: |
34+
python -m pip install --upgrade setuptools pip wheel
35+
python -m pip install nox
36+
- name: Run docfx
37+
run: |
38+
nox -s docfx

‎.github/workflows/lint.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
on:
2+
pull_request:
3+
branches:
4+
- main
5+
name: lint
6+
jobs:
7+
lint:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v3
12+
- name: Setup Python
13+
uses: actions/setup-python@v4
14+
with:
15+
python-version: "3.10"
16+
- name: Install nox
17+
run: |
18+
python -m pip install --upgrade setuptools pip wheel
19+
python -m pip install nox
20+
- name: Run lint
21+
run: |
22+
nox -s lint
23+
- name: Run lint_setup_py
24+
run: |
25+
nox -s lint_setup_py

‎.github/workflows/unittest.yml

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
on:
2+
pull_request:
3+
branches:
4+
- main
5+
name: unittest
6+
jobs:
7+
unit:
8+
runs-on: ubuntu-latest
9+
strategy:
10+
matrix:
11+
python: ['3.9', '3.10', '3.11']
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v3
15+
- name: Setup Python
16+
uses: actions/setup-python@v4
17+
with:
18+
python-version: ${{ matrix.python }}
19+
- name: Install nox
20+
run: |
21+
python -m pip install --upgrade setuptools pip wheel
22+
python -m pip install nox
23+
- name: Run unit tests
24+
env:
25+
COVERAGE_FILE: .coverage-${{ matrix.python }}
26+
run: |
27+
nox -s unit-${{ matrix.python }}
28+
- name: Upload coverage results
29+
uses: actions/upload-artifact@v3
30+
with:
31+
name: coverage-artifacts
32+
path: .coverage-${{ matrix.python }}
33+
34+
cover:
35+
runs-on: ubuntu-latest
36+
needs:
37+
- unit
38+
steps:
39+
- name: Checkout
40+
uses: actions/checkout@v3
41+
- name: Setup Python
42+
uses: actions/setup-python@v4
43+
with:
44+
python-version: "3.10"
45+
- name: Install coverage
46+
run: |
47+
python -m pip install --upgrade setuptools pip wheel
48+
python -m pip install coverage
49+
- name: Download coverage results
50+
uses: actions/download-artifact@v3
51+
with:
52+
name: coverage-artifacts
53+
path: .coverage-results/
54+
- name: Report coverage results
55+
run: |
56+
coverage combine .coverage-results/.coverage*
57+
coverage report --show-missing --fail-under=40

‎SECURITY.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Security Policy
2+
3+
To report a security issue, please use [g.co/vulnz](https://g.co/vulnz).
4+
5+
The Google Security Team will respond within 5 working days of your report on g.co/vulnz.
6+
7+
We use g.co/vulnz for our intake, and do coordination and disclosure here using GitHub Security Advisory to privately discuss and fix the issue.

‎owlbot.py

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Copyright 2021 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
"""This script is used to synthesize generated parts of this library."""
16+
17+
import pathlib
18+
19+
from synthtool import gcp
20+
import synthtool as s
21+
from synthtool.languages import python
22+
23+
REPO_ROOT = pathlib.Path(__file__).parent.absolute()
24+
25+
common = gcp.CommonTemplates()
26+
27+
# ----------------------------------------------------------------------------
28+
# Add templated files
29+
# ----------------------------------------------------------------------------
30+
31+
templated_files = common.py_library(
32+
unit_test_python_versions=["3.9", "3.10", "3.11"],
33+
system_test_python_versions=["3.9", "3.11"],
34+
cov_level=40,
35+
intersphinx_dependencies={
36+
"pandas": "https://pandas.pydata.org/pandas-docs/stable/",
37+
"pydata-google-auth": "https://pydata-google-auth.readthedocs.io/en/latest/",
38+
},
39+
)
40+
s.move(
41+
templated_files,
42+
excludes=[
43+
# Multi-processing note isn't relevant, as pandas_gbq is responsible for
44+
# creating clients, not the end user.
45+
"docs/multiprocessing.rst",
46+
"noxfile.py",
47+
"README.rst",
48+
],
49+
)
50+
51+
# ----------------------------------------------------------------------------
52+
# Fixup files
53+
# ----------------------------------------------------------------------------
54+
55+
56+
# ----------------------------------------------------------------------------
57+
# Samples templates
58+
# ----------------------------------------------------------------------------
59+
60+
python.py_samples(skip_readmes=True)
61+
62+
# ----------------------------------------------------------------------------
63+
# Final cleanup
64+
# ----------------------------------------------------------------------------
65+
66+
s.shell.run(["nox", "-s", "blacken"], hide_output=False)
67+
for noxfile in REPO_ROOT.glob("samples/**/noxfile.py"):
68+
s.shell.run(["nox", "-s", "blacken"], cwd=noxfile.parent, hide_output=False)

0 commit comments

Comments
 (0)