From 4b1a474f4dbfecd07180580bd23212a5ac00a3d9 Mon Sep 17 00:00:00 2001 From: Dan Lee <71398022+dandhlee@users.noreply.github.com> Date: Fri, 27 Aug 2021 17:20:48 -0400 Subject: [PATCH] chore: migrate to main branch (#239) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: - [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-dlp/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 #238 🦕 --- .../.github/sync-repo-settings.yaml | 8 ++-- packages/google-cloud-dlp/.kokoro/build.sh | 2 +- .../.kokoro/test-samples-impl.sh | 2 +- packages/google-cloud-dlp/CONTRIBUTING.rst | 12 +++--- packages/google-cloud-dlp/docs/conf.py | 10 ++--- packages/google-cloud-dlp/owlbot.py | 41 +++++++++++++++++++ packages/google-cloud-dlp/setup.py | 1 + 7 files changed, 59 insertions(+), 17 deletions(-) diff --git a/packages/google-cloud-dlp/.github/sync-repo-settings.yaml b/packages/google-cloud-dlp/.github/sync-repo-settings.yaml index a5874225a2d8..2353296df2f4 100644 --- a/packages/google-cloud-dlp/.github/sync-repo-settings.yaml +++ b/packages/google-cloud-dlp/.github/sync-repo-settings.yaml @@ -1,9 +1,9 @@ -# https://github.com/googleapis/repo-automation-bots/tree/master/packages/sync-repo-settings -# Rules for master branch protection +# https://github.com/googleapis/repo-automation-bots/tree/main/packages/sync-repo-settings +# Rules for main branch protection branchProtectionRules: # Identifies the protection rule pattern. Name of the branch to be protected. -# Defaults to `master` -- pattern: master +# Defaults to `main` +- pattern: main requiresCodeOwnerReviews: true requiresStrictStatusChecks: true requiredStatusCheckContexts: diff --git a/packages/google-cloud-dlp/.kokoro/build.sh b/packages/google-cloud-dlp/.kokoro/build.sh index 3ffa76f79998..c09d2415c6b9 100755 --- a/packages/google-cloud-dlp/.kokoro/build.sh +++ b/packages/google-cloud-dlp/.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/packages/google-cloud-dlp/.kokoro/test-samples-impl.sh b/packages/google-cloud-dlp/.kokoro/test-samples-impl.sh index 311a8d54b9f1..8a324c9c7bc6 100755 --- a/packages/google-cloud-dlp/.kokoro/test-samples-impl.sh +++ b/packages/google-cloud-dlp/.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/packages/google-cloud-dlp/CONTRIBUTING.rst b/packages/google-cloud-dlp/CONTRIBUTING.rst index ea987d3cf2c7..26b68f1a718c 100644 --- a/packages/google-cloud-dlp/CONTRIBUTING.rst +++ b/packages/google-cloud-dlp/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/python-dlp # repository into your local repository. $ git remote add upstream git@github.com:googleapis/python-dlp.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 ``python-dlp``. 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/python-dlp/blob/master/CONTRIBUTING.rst``) +``https://github.com/googleapis/python-dlp/blob/main/CONTRIBUTING.rst``) may cause problems creating links or rendering the description. .. _description on PyPI: https://pypi.org/project/google-cloud-dlp @@ -234,7 +234,7 @@ We support: Supported versions can be found in our ``noxfile.py`` `config`_. -.. _config: https://github.com/googleapis/python-dlp/blob/master/noxfile.py +.. _config: https://github.com/googleapis/python-dlp/blob/main/noxfile.py We also explicitly decided to support Python 3 beginning with version 3.6. diff --git a/packages/google-cloud-dlp/docs/conf.py b/packages/google-cloud-dlp/docs/conf.py index 87f9f61bae2f..c83d1a70dd2b 100644 --- a/packages/google-cloud-dlp/docs/conf.py +++ b/packages/google-cloud-dlp/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 main toctree document. +root_doc = "index" # General information about the project. project = "google-cloud-dlp" @@ -280,7 +280,7 @@ # author, documentclass [howto, manual, or own class]). latex_documents = [ ( - master_doc, + root_doc, "google-cloud-dlp.tex", "google-cloud-dlp Documentation", author, @@ -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-cloud-dlp", "google-cloud-dlp Documentation", [author], 1,) + (root_doc, "google-cloud-dlp", "google-cloud-dlp Documentation", [author], 1,) ] # If true, show URL addresses after external links. @@ -328,7 +328,7 @@ # dir menu entry, description, category) texinfo_documents = [ ( - master_doc, + root_doc, "google-cloud-dlp", "google-cloud-dlp Documentation", author, diff --git a/packages/google-cloud-dlp/owlbot.py b/packages/google-cloud-dlp/owlbot.py index 2b67bf87b80d..42ebb11b92ed 100644 --- a/packages/google-cloud-dlp/owlbot.py +++ b/packages/google-cloud-dlp/owlbot.py @@ -45,3 +45,44 @@ s.replace("noxfile.py", '[\"\']-W[\"\']', '# "-W"') s.shell.run(["nox", "-s", "blacken"], hide_output=False) + +# ---------------------------------------------------------------------------- +# Main Branch migration +# ---------------------------------------------------------------------------- + +s.replace( + "*.rst", + "master", + "main" +) + +s.replace( + "CONTRIBUTING.rst", + "kubernetes/community/blob/main", + "kubernetes/community/blob/master" +) + +s.replace( + "docs/conf.py", + "master", + "main" +) + +s.replace( + "docs/conf.py", + "main_doc", + "root_doc" +) + +s.replace( + ".kokoro/*", + "master", + "main" +) + +s.replace( + "README.rst", + "google-cloud-python/blob/main/README.rst", + "google-cloud-python/blob/master/README.rst" +) + diff --git a/packages/google-cloud-dlp/setup.py b/packages/google-cloud-dlp/setup.py index f41d2802b21a..282af918f408 100644 --- a/packages/google-cloud-dlp/setup.py +++ b/packages/google-cloud-dlp/setup.py @@ -30,6 +30,7 @@ "google-api-core[grpc] >= 1.26.0, <3.0.0dev", "proto-plus >= 0.4.0", "packaging >= 14.3", + "pytz >= 2021.1", ] extras = {"libcst": "libcst >= 0.2.5"}