Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: migrate default branch to main #264

Merged
merged 6 commits into from Aug 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .kokoro/build.sh
Expand Up @@ -41,7 +41,7 @@ python3 -m pip install --upgrade --quiet nox
python3 -m nox --version

# If this is a continuous build, send the test log to the FlakyBot.
# See https://github.com/googleapis/repo-automation-bots/tree/master/packages/flakybot.
# See https://github.com/googleapis/repo-automation-bots/tree/main/packages/flakybot.
if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"continuous"* ]]; then
cleanup() {
chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot
Expand Down
2 changes: 1 addition & 1 deletion .kokoro/test-samples-impl.sh
Expand Up @@ -80,7 +80,7 @@ for file in samples/**/requirements.txt; do
EXIT=$?

# If this is a periodic build, send the test log to the FlakyBot.
# See https://github.com/googleapis/repo-automation-bots/tree/master/packages/flakybot.
# See https://github.com/googleapis/repo-automation-bots/tree/main/packages/flakybot.
if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then
chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot
$KOKORO_GFILE_DIR/linux_amd64/flakybot
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.rst
Expand Up @@ -49,9 +49,9 @@ You'll have to create a development environment using a Git checkout:
# Configure remotes such that you can pull changes from the googleapis/python-api-core
# repository into your local repository.
$ git remote add upstream git@github.com:googleapis/python-api-core.git
# fetch and merge changes from upstream into master
# fetch and merge changes from upstream into main
$ git fetch upstream
$ git merge upstream/master
$ git merge upstream/main

Now your local repo is set up such that you will push changes to your GitHub
repo, from which you can submit a pull request.
Expand Down Expand Up @@ -109,12 +109,12 @@ Coding Style
variables::

export GOOGLE_CLOUD_TESTING_REMOTE="upstream"
export GOOGLE_CLOUD_TESTING_BRANCH="master"
export GOOGLE_CLOUD_TESTING_BRANCH="main"

By doing this, you are specifying the location of the most up-to-date
version of ``python-api-core``. The the suggested remote name ``upstream``
should point to the official ``googleapis`` checkout and the
the branch should be the main branch on that remote (``master``).
the branch should be the main branch on that remote (``main``).

- This repository contains configuration for the
`pre-commit <https://pre-commit.com/>`__ tool, which automates checking
Expand Down Expand Up @@ -185,7 +185,7 @@ The `description on PyPI`_ for the project comes directly from the
``README``. Due to the reStructuredText (``rst``) parser used by
PyPI, relative links which will work on GitHub (e.g. ``CONTRIBUTING.rst``
instead of
``https://github.com/googleapis/python-api-core/blob/master/CONTRIBUTING.rst``)
``https://github.com/googleapis/python-api-core/blob/main/CONTRIBUTING.rst``)
may cause problems creating links or rendering the description.

.. _description on PyPI: https://pypi.org/project/google-api-core
Expand All @@ -210,7 +210,7 @@ We support:

Supported versions can be found in our ``noxfile.py`` `config`_.

.. _config: https://github.com/googleapis/python-api-core/blob/master/noxfile.py
.. _config: https://github.com/googleapis/python-api-core/blob/main/noxfile.py


We also explicitly decided to support Python 3 beginning with version 3.6.
Expand Down
10 changes: 5 additions & 5 deletions docs/conf.py
Expand Up @@ -76,8 +76,8 @@
# The encoding of source files.
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = "index"
# The root toctree document.
root_doc = "index"

# General information about the project.
project = "google-api-core"
Expand Down Expand Up @@ -280,7 +280,7 @@
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(
master_doc,
root_doc,
"google-api-core.tex",
"google-api-core Documentation",
author,
Expand Down Expand Up @@ -314,7 +314,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, "google-api-core", "google-api-core Documentation", [author], 1,)
(root_doc, "google-api-core", "google-api-core Documentation", [author], 1,)
]

# If true, show URL addresses after external links.
Expand All @@ -328,7 +328,7 @@
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
root_doc,
"google-api-core",
"google-api-core Documentation",
author,
Expand Down
3 changes: 1 addition & 2 deletions google/api_core/exceptions.py
Expand Up @@ -293,8 +293,7 @@ class Cancelled(ClientError):
"""Exception mapping a :attr:`grpc.StatusCode.CANCELLED` error."""

# This maps to HTTP status code 499. See
# https://github.com/googleapis/googleapis/blob/master/google/rpc\
# /code.proto
# https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
code = 499
grpc_status_code = grpc.StatusCode.CANCELLED if grpc is not None else None

Expand Down
6 changes: 4 additions & 2 deletions google/api_core/future/async_future.py
Expand Up @@ -43,8 +43,10 @@ class AsyncFuture(base.Future):
The :meth:`done` method should be implemented by subclasses. The polling
behavior will repeatedly call ``done`` until it returns True.

.. note: Privacy here is intended to prevent the final class from
overexposing, not to prevent subclasses from accessing methods.
.. note::

Privacy here is intended to prevent the final class from
overexposing, not to prevent subclasses from accessing methods.

Args:
retry (google.api_core.retry.Retry): The retry configuration used
Expand Down
6 changes: 4 additions & 2 deletions google/api_core/future/polling.py
Expand Up @@ -45,8 +45,10 @@ class PollingFuture(base.Future):
The :meth:`done` method should be implemented by subclasses. The polling
behavior will repeatedly call ``done`` until it returns True.

.. note: Privacy here is intended to prevent the final class from
overexposing, not to prevent subclasses from accessing methods.
.. note::

Privacy here is intended to prevent the final class from
overexposing, not to prevent subclasses from accessing methods.

Args:
retry (google.api_core.retry.Retry): The retry configuration used
Expand Down
12 changes: 11 additions & 1 deletion noxfile.py
Expand Up @@ -29,7 +29,17 @@
DEFAULT_PYTHON_VERSION = "3.7"
CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute()

_MINIMAL_ASYNCIO_SUPPORT_PYTHON_VERSION = [3, 6]
# 'docfx' is excluded since it only needs to run in 'docs-presubmit'
nox.options.sessions = [
"unit",
"unit_grpc_gcp",
"cover",
"pytype",
"lint",
"lint_setup_py",
"blacken",
"docs",
]


def _greater_or_equal_than_36(version_string):
Expand Down
45 changes: 45 additions & 0 deletions owlbot.py
Expand Up @@ -44,4 +44,49 @@
""",
)

# Remove the replacements below once https://github.com/googleapis/synthtool/pull/1188 is merged

# Update googleapis/repo-automation-bots repo to main in .kokoro/*.sh files
s.replace(
".kokoro/*.sh", "repo-automation-bots/tree/master", "repo-automation-bots/tree/main"
)

# Customize CONTRIBUTING.rst to replace master with main
s.replace(
"CONTRIBUTING.rst",
"fetch and merge changes from upstream into master",
"fetch and merge changes from upstream into main",
)

s.replace(
"CONTRIBUTING.rst", "git merge upstream/master", "git merge upstream/main",
)

s.replace(
"CONTRIBUTING.rst",
"""export GOOGLE_CLOUD_TESTING_BRANCH=\"master\"""",
"""export GOOGLE_CLOUD_TESTING_BRANCH=\"main\"""",
)

s.replace(
"CONTRIBUTING.rst", r"remote \(``master``\)", "remote (``main``)",
)

s.replace(
"CONTRIBUTING.rst", "blob/master/CONTRIBUTING.rst", "blob/main/CONTRIBUTING.rst",
)

s.replace(
"CONTRIBUTING.rst", "blob/master/noxfile.py", "blob/main/noxfile.py",
)

s.replace(
"docs/conf.py", "master_doc", "root_doc",
)

s.replace(
"docs/conf.py", "# The master toctree document.", "# The root toctree document.",
)


s.shell.run(["nox", "-s", "blacken"], hide_output=False)