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

docs: migrate to main branch #76

Merged
merged 8 commits into from Aug 23, 2021
Merged
Show file tree
Hide file tree
Changes from 5 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
14 changes: 7 additions & 7 deletions CONTRIBUTING.rst
Expand Up @@ -8,7 +8,7 @@ Contributing
#. Make sure that your commit messages clearly describe the changes.
#. Send a pull request. (Please Read: `Faster Pull Request Reviews`_)

.. _Faster Pull Request Reviews: https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
.. _Faster Pull Request Reviews: https://github.com/kubernetes/community/blob/main/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
parthea marked this conversation as resolved.
Show resolved Hide resolved

.. contents:: Here are some guidelines for hacking on the Google Cloud Client libraries.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
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 main toctree document.
main_doc = "index"
parthea marked this conversation as resolved.
Show resolved Hide resolved

# General information about the project.
project = "google-cloud-access-context-manager"
Expand Down Expand Up @@ -280,7 +280,7 @@
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(
master_doc,
main_doc,
"google-cloud-access-context-manager.tex",
"google-cloud-access-context-manager Documentation",
author,
Expand Down Expand Up @@ -315,7 +315,7 @@
# (source start file, name, description, authors, manual section).
man_pages = [
(
master_doc,
main_doc,
"google-cloud-access-context-manager",
"google-cloud-access-context-manager Documentation",
[author],
Expand All @@ -334,7 +334,7 @@
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
main_doc,
"google-cloud-access-context-manager",
"google-cloud-access-context-manager Documentation",
author,
Expand Down
18 changes: 18 additions & 0 deletions owlbot.py
Expand Up @@ -183,3 +183,21 @@ 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(
"docs/conf.py",
"master",
"main"
)

s.replace(
".kokoro/*",
"master",
"main"
)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you have to use owlbot for this because we can't update the templates yet?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I believe the plan is to update on the branches first, and then we'll update the templates. Once that's done we'll revert the changes on OwlBot.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another suggestion is to have a flag that switches main/master in the templates so it's a one line change. Post-migration you can just make main the default.

I did something similar back when we were moving to the microgenerator.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good @busunkim96, do you have any links for the previous PRs with those examples? Can't visualize how that'd work here :/