-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add split repo templates (#4)
- Loading branch information
1 parent
93de7d4
commit ed27b3c
Showing
29 changed files
with
840 additions
and
342 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# How to Contribute | ||
|
||
We'd love to accept your patches and contributions to this project. There are | ||
just a few small guidelines you need to follow. | ||
|
||
## Contributor License Agreement | ||
|
||
Contributions to this project must be accompanied by a Contributor License | ||
Agreement. You (or your employer) retain the copyright to your contribution; | ||
this simply gives us permission to use and redistribute your contributions as | ||
part of the project. Head over to <https://cla.developers.google.com/> to see | ||
your current agreements on file or to sign a new one. | ||
|
||
You generally only need to submit a CLA once, so if you've already submitted one | ||
(even if it was for a different project), you probably don't need to do it | ||
again. | ||
|
||
## Code reviews | ||
|
||
All submissions, including submissions by project members, require review. We | ||
use GitHub pull requests for this purpose. Consult | ||
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more | ||
information on using pull requests. | ||
|
||
## Community Guidelines | ||
|
||
This project follows [Google's Open Source Community | ||
Guidelines](https://opensource.google.com/conduct/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
Thanks for stopping by to let us know something could be better! | ||
|
||
**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. | ||
|
||
Please run down the following list and make sure you've tried the usual "quick fixes": | ||
|
||
- Search the issues already opened: https://github.com/googleapis/python-speech/issues | ||
- Search the issues on our "catch-all" repository: https://github.com/googleapis/google-cloud-python | ||
- Search StackOverflow: http://stackoverflow.com/questions/tagged/google-cloud-platform+python | ||
|
||
If you are still having issues, please be sure to include as much information as possible: | ||
|
||
#### Environment details | ||
|
||
- OS type and version: | ||
- Python version: `python --version` | ||
- pip version: `pip --version` | ||
- `google-cloud-speech` version: `pip show google-cloud-speech` | ||
|
||
#### Steps to reproduce | ||
|
||
1. ? | ||
2. ? | ||
|
||
#### Code example | ||
|
||
```python | ||
# example | ||
``` | ||
|
||
#### Stack trace | ||
``` | ||
# example | ||
``` | ||
|
||
Making sure to follow these steps will guarantee the quickest resolution possible. | ||
|
||
Thanks! |
18 changes: 18 additions & 0 deletions
18
google-cloud-speech/.github/ISSUE_TEMPLATE/feature_request.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this library | ||
|
||
--- | ||
|
||
Thanks for stopping by to let us know something could be better! | ||
|
||
**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. | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
7 changes: 7 additions & 0 deletions
7
google-cloud-speech/.github/ISSUE_TEMPLATE/support_request.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
name: Support request | ||
about: If you have a support contract with Google, please create an issue in the Google Cloud Support console. | ||
|
||
--- | ||
|
||
**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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
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: | ||
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-speech/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea | ||
- [ ] Ensure the tests and linter pass | ||
- [ ] Code coverage does not decrease (if any source code was changed) | ||
- [ ] Appropriate docs were updated (if necessary) | ||
|
||
Fixes #<issue_number_goes_here> 🦕 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
releaseType: python |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
*.py[cod] | ||
*.sw[op] | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Packages | ||
*.egg | ||
*.egg-info | ||
dist | ||
build | ||
eggs | ||
parts | ||
bin | ||
var | ||
sdist | ||
develop-eggs | ||
.installed.cfg | ||
lib | ||
lib64 | ||
__pycache__ | ||
|
||
# Installer logs | ||
pip-log.txt | ||
|
||
# Unit test / coverage reports | ||
.coverage | ||
.nox | ||
.cache | ||
.pytest_cache | ||
|
||
|
||
# Mac | ||
.DS_Store | ||
|
||
# JetBrains | ||
.idea | ||
|
||
# VS Code | ||
.vscode | ||
|
||
# emacs | ||
*~ | ||
|
||
# Built documentation | ||
docs/_build | ||
bigquery/docs/generated | ||
|
||
# Virtual environment | ||
env/ | ||
coverage.xml | ||
|
||
# System test environment variables. | ||
system_tests/local_test_setup | ||
|
||
# Make sure a generated file isn't accidentally committed. | ||
pylintrc | ||
pylintrc.test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
#!/bin/bash | ||
# Copyright 2018 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
set -eo pipefail | ||
|
||
cd github/python-speech | ||
|
||
# Disable buffering, so that the logs stream through. | ||
export PYTHONUNBUFFERED=1 | ||
|
||
# Debug: show build environment | ||
env | grep KOKORO | ||
|
||
# Setup service account credentials. | ||
export GOOGLE_APPLICATION_CREDENTIALS=${KOKORO_GFILE_DIR}/service-account.json | ||
|
||
# Setup project id. | ||
export PROJECT_ID=$(cat "${KOKORO_GFILE_DIR}/project-id.json") | ||
|
||
# Remove old nox | ||
python3.6 -m pip uninstall --yes --quiet nox-automation | ||
|
||
# Install nox | ||
python3.6 -m pip install --upgrade --quiet nox | ||
python3.6 -m nox --version | ||
|
||
python3.6 -m nox |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
# Build logs will be here | ||
action { | ||
define_artifacts { | ||
regex: "**/*sponge_log.xml" | ||
} | ||
} | ||
|
||
# Download trampoline resources. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" | ||
|
||
# Download resources for system tests (service account key, etc.) | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/google-cloud-python" | ||
|
||
# Use the trampoline script to run in docker. | ||
build_file: "python-speech/.kokoro/trampoline.sh" | ||
|
||
# Configure the docker image for kokoro-trampoline. | ||
env_vars: { | ||
key: "TRAMPOLINE_IMAGE" | ||
value: "gcr.io/cloud-devrel-kokoro-resources/python-multi" | ||
} | ||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/python-speech/.kokoro/build.sh" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
# Build logs will be here | ||
action { | ||
define_artifacts { | ||
regex: "**/*sponge_log.xml" | ||
} | ||
} | ||
|
||
# Download trampoline resources. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" | ||
|
||
# Use the trampoline script to run in docker. | ||
build_file: "python-speech/.kokoro/trampoline.sh" | ||
|
||
# Configure the docker image for kokoro-trampoline. | ||
env_vars: { | ||
key: "TRAMPOLINE_IMAGE" | ||
value: "gcr.io/cloud-devrel-kokoro-resources/python-multi" | ||
} | ||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/python-speech/.kokoro/publish-docs.sh" | ||
} | ||
|
||
env_vars: { | ||
key: "STAGING_BUCKET" | ||
value: "docs-staging" | ||
} | ||
|
||
# Fetch the token needed for reporting release status to GitHub | ||
before_action { | ||
fetch_keystore { | ||
keystore_resource { | ||
keystore_config_id: 73713 | ||
keyname: "yoshi-automation-github-key" | ||
} | ||
} | ||
} | ||
|
||
before_action { | ||
fetch_keystore { | ||
keystore_resource { | ||
keystore_config_id: 73713 | ||
keyname: "docuploader_service_account" | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto | ||
|
||
# Build logs will be here | ||
action { | ||
define_artifacts { | ||
regex: "**/*sponge_log.xml" | ||
} | ||
} | ||
|
||
# Download trampoline resources. | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/trampoline" | ||
|
||
# Download resources for system tests (service account key, etc.) | ||
gfile_resources: "/bigstore/cloud-devrel-kokoro-resources/google-cloud-python" | ||
|
||
# Use the trampoline script to run in docker. | ||
build_file: "python-speech/.kokoro/trampoline.sh" | ||
|
||
# Configure the docker image for kokoro-trampoline. | ||
env_vars: { | ||
key: "TRAMPOLINE_IMAGE" | ||
value: "gcr.io/cloud-devrel-kokoro-resources/python-multi" | ||
} | ||
env_vars: { | ||
key: "TRAMPOLINE_BUILD_FILE" | ||
value: "github/python-speech/.kokoro/build.sh" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Format: //devtools/kokoro/config/proto/build.proto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
#!/bin/bash | ||
# Copyright 2020 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
#!/bin/bash | ||
|
||
set -eo pipefail | ||
|
||
# Disable buffering, so that the logs stream through. | ||
export PYTHONUNBUFFERED=1 | ||
|
||
cd github/python-speech | ||
|
||
# Remove old nox | ||
python3.6 -m pip uninstall --yes --quiet nox-automation | ||
|
||
# Install nox | ||
python3.6 -m pip install --upgrade --quiet nox | ||
python3.6 -m nox --version | ||
|
||
# build docs | ||
nox -s docs | ||
|
||
python3 -m pip install gcp-docuploader | ||
|
||
# install a json parser | ||
sudo apt-get update | ||
sudo apt-get -y install software-properties-common | ||
sudo add-apt-repository universe | ||
sudo apt-get update | ||
sudo apt-get -y install jq | ||
|
||
# create metadata | ||
python3 -m docuploader create-metadata \ | ||
--name=$(jq --raw-output '.name // empty' .repo-metadata.json) \ | ||
--version=$(python3 setup.py --version) \ | ||
--language=$(jq --raw-output '.language // empty' .repo-metadata.json) \ | ||
--distribution-name=$(python3 setup.py --name) \ | ||
--product-page=$(jq --raw-output '.product_documentation // empty' .repo-metadata.json) \ | ||
--github-repository=$(jq --raw-output '.repo // empty' .repo-metadata.json) \ | ||
--issue-tracker=$(jq --raw-output '.issue_tracker // empty' .repo-metadata.json) | ||
|
||
cat docs.metadata | ||
|
||
# upload docs | ||
python3 -m docuploader upload docs/_build/html --metadata-file docs.metadata --staging-bucket docs-staging |
Oops, something went wrong.