Skip to content
Permalink
Browse files
docs: migrate to main branch (#76)
* docs: move to main branch

* πŸ¦‰ Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* chore: ignore Kokoro files for Owlbot

* πŸ¦‰ Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* chore: update local OwlBot template.

* πŸ¦‰ Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
dandhlee and gcf-owl-bot committed Aug 23, 2021
1 parent a5b4fc9 commit 4f36a1dad07554ef676c7b01a9f1bd0e132bdb01
Showing with 43 additions and 13 deletions.
  1. +1 βˆ’1 .kokoro/build.sh
  2. +1 βˆ’1 .kokoro/test-samples-impl.sh
  3. +6 βˆ’6 CONTRIBUTING.rst
  4. +5 βˆ’5 docs/conf.py
  5. +30 βˆ’0 owlbot.py
@@ -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
@@ -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
@@ -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-access-context-manager
# repository into your local repository.
$ git remote add upstream git@github.com:googleapis/python-access-context-manager.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-access-context-manager``. 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
@@ -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-access-context-manager/blob/master/CONTRIBUTING.rst``)
``https://github.com/googleapis/python-access-context-manager/blob/main/CONTRIBUTING.rst``)
may cause problems creating links or rendering the description.

.. _description on PyPI: https://pypi.org/project/google-cloud-access-context-manager
@@ -234,7 +234,7 @@ We support:

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

.. _config: https://github.com/googleapis/python-access-context-manager/blob/master/noxfile.py
.. _config: https://github.com/googleapis/python-access-context-manager/blob/main/noxfile.py


We also explicitly decided to support Python 3 beginning with version 3.6.
@@ -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-access-context-manager"
@@ -280,7 +280,7 @@
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(
master_doc,
root_doc,
"google-cloud-access-context-manager.tex",
"google-cloud-access-context-manager Documentation",
author,
@@ -315,7 +315,7 @@
# (source start file, name, description, authors, manual section).
man_pages = [
(
master_doc,
root_doc,
"google-cloud-access-context-manager",
"google-cloud-access-context-manager Documentation",
[author],
@@ -334,7 +334,7 @@
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
root_doc,
"google-cloud-access-context-manager",
"google-cloud-access-context-manager Documentation",
author,
@@ -183,3 +183,33 @@ def generate_protos(session):
PB2_GRPC_HEADER,
fr"{LICENSE}\n\n\g<1>\n\n\g<2>", # add line breaks to avoid stacking replacements
)

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

s.replace(
"CONTRIBUTING.rst",
"https://github.com/kubernetes/community/blob/main/",
"https://github.com/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"
)

0 comments on commit 4f36a1d

Please sign in to comment.