From d36d745ccf582f38f1cf4d20d4a1b789803ff14a Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Wed, 25 Aug 2021 18:42:45 +0000 Subject: [PATCH] chore: migrate default branch from master to main --- .kokoro/build.sh | 2 +- .kokoro/test-samples-impl.sh | 2 +- CONTRIBUTING.rst | 12 ++++---- README.rst | 4 +-- docs/conf.py | 10 +++--- google_auth_oauthlib/flow.py | 7 ++--- google_auth_oauthlib/helpers.py | 6 ++-- owlbot.py | 54 +++++++++++++++++++++++++++++++++ 8 files changed, 74 insertions(+), 23 deletions(-) diff --git a/.kokoro/build.sh b/.kokoro/build.sh index 38efc61..8219e51 100755 --- a/.kokoro/build.sh +++ b/.kokoro/build.sh @@ -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 diff --git a/.kokoro/test-samples-impl.sh b/.kokoro/test-samples-impl.sh index 311a8d5..8a324c9 100755 --- a/.kokoro/test-samples-impl.sh +++ b/.kokoro/test-samples-impl.sh @@ -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 diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e92c0f1..93a5391 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -50,9 +50,9 @@ You'll have to create a development environment using a Git checkout: # Configure remotes such that you can pull changes from the googleapis/google-auth-library-python-oauthlib # repository into your local repository. $ git remote add upstream git@github.com:googleapis/google-auth-library-python-oauthlib.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. @@ -110,12 +110,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 ``google-auth-library-python-oauthlib``. 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 `__ tool, which automates checking @@ -209,7 +209,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/google-auth-library-python-oauthlib/blob/master/CONTRIBUTING.rst``) +``https://github.com/googleapis/google-auth-library-python-oauthlib/blob/main/CONTRIBUTING.rst``) may cause problems creating links or rendering the description. .. _description on PyPI: https://pypi.org/project/google-auth-oauthlib @@ -234,7 +234,7 @@ We support: Supported versions can be found in our ``noxfile.py`` `config`_. -.. _config: https://github.com/googleapis/google-auth-library-python-oauthlib/blob/master/noxfile.py +.. _config: https://github.com/googleapis/google-auth-library-python-oauthlib/blob/main/noxfile.py We also explicitly decided to support Python 3 beginning with version 3.6. diff --git a/README.rst b/README.rst index e20b55a..7fe2be2 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ oauthlib integration for Google Auth This library provides `oauthlib`_ integration with `google-auth`_. -.. |build| image:: https://travis-ci.org/googleapis/google-auth-library-python-oauthlib.svg?branch=master +.. |build| image:: https://travis-ci.org/googleapis/google-auth-library-python-oauthlib.svg?branch=main :target: https://travis-ci.org/googleapis/google-auth-library-python-oauthlib .. |docs| image:: https://readthedocs.org/projects/google-auth-oauthlib/badge/?version=latest :target: https://google-auth-oauthlib.readthedocs.io/en/latest/ @@ -49,4 +49,4 @@ License Apache 2.0 - See `the LICENSE`_ for more information. -.. _the LICENSE: https://github.com/googleapis/google-auth-library-python-oauthlib/blob/master/LICENSE +.. _the LICENSE: https://github.com/googleapis/google-auth-library-python-oauthlib/blob/main/LICENSE diff --git a/docs/conf.py b/docs/conf.py index 93d5b5a..f54fee9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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-auth-oauthlib" @@ -280,7 +280,7 @@ # author, documentclass [howto, manual, or own class]). latex_documents = [ ( - master_doc, + root_doc, "google-auth-oauthlib.tex", "google-auth-oauthlib Documentation", author, @@ -315,7 +315,7 @@ # (source start file, name, description, authors, manual section). man_pages = [ ( - master_doc, + root_doc, "google-auth-oauthlib", "google-auth-oauthlib Documentation", [author], @@ -334,7 +334,7 @@ # dir menu entry, description, category) texinfo_documents = [ ( - master_doc, + root_doc, "google-auth-oauthlib", "google-auth-oauthlib Documentation", author, diff --git a/google_auth_oauthlib/flow.py b/google_auth_oauthlib/flow.py index 0c67c6c..04c06f1 100644 --- a/google_auth_oauthlib/flow.py +++ b/google_auth_oauthlib/flow.py @@ -119,7 +119,7 @@ def __init__( code_verifier. .. _client secrets: https://github.com/googleapis/google-api-python-client/blob - /master/docs/client-secrets.md + /main/docs/client-secrets.md """ self.client_type = client_type """str: The client type, either ``'web'`` or ``'installed'``""" @@ -152,8 +152,7 @@ def from_client_config(cls, client_config, scopes, **kwargs): format. .. _client secrets: - https://github.com/googleapis/google-api-python-client/blob/ - master/docs/client-secrets.md + https://github.com/googleapis/google-api-python-client/blob/main/docs/client-secrets.md """ if "web" in client_config: client_type = "web" @@ -356,7 +355,7 @@ class InstalledAppFlow(Flow): response, such as using an embedded web view. .. _Installed Application Authorization Flow: - https://github.com/googleapis/google-api-python-client/blob/master/docs/oauth-installed.md + https://github.com/googleapis/google-api-python-client/blob/main/docs/oauth-installed.md """ _OOB_REDIRECT_URI = "urn:ietf:wg:oauth:2.0:oob" diff --git a/google_auth_oauthlib/helpers.py b/google_auth_oauthlib/helpers.py index bc09319..7dea24d 100644 --- a/google_auth_oauthlib/helpers.py +++ b/google_auth_oauthlib/helpers.py @@ -51,8 +51,7 @@ def session_from_client_config(client_config, scopes, **kwargs): oauthlib session and the validated client configuration. .. _client secrets: - https://github.com/googleapis/google-api-python-client/blob/master/ - docs/client-secrets.md + https://github.com/googleapis/google-api-python-client/blob/main/docs/client-secrets.md """ if "web" in client_config: @@ -89,8 +88,7 @@ def session_from_client_secrets_file(client_secrets_file, scopes, **kwargs): oauthlib session and the validated client configuration. .. _client secrets: - https://github.com/googleapis/google-api-python-client/blob/master/ - docs/client-secrets.md + https://github.com/googleapis/google-api-python-client/blob/main/docs/client-secrets.md """ with open(client_secrets_file, "r") as json_file: client_config = json.load(json_file) diff --git a/owlbot.py b/owlbot.py index dab1f94..f8b3a73 100644 --- a/owlbot.py +++ b/owlbot.py @@ -43,4 +43,58 @@ r'value: "docs-staging-v2-staging"' ) +# 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", + "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)