Skip to content
This repository was archived by the owner on Jul 6, 2023. It is now read-only.

Commit 7edab48

Browse files
authored
docs: migrate to main branch (#20)
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-data-fusion/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [x] Ensure the tests and linter pass - [x] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary) Fixes #19 🦕 Release-As: 1.0.0
1 parent e1ee3ff commit 7edab48

File tree

6 files changed

+50
-15
lines changed

6 files changed

+50
-15
lines changed

.kokoro/build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ python3 -m pip install --upgrade --quiet nox
4141
python3 -m nox --version
4242

4343
# If this is a continuous build, send the test log to the FlakyBot.
44-
# See https://github.com/googleapis/repo-automation-bots/tree/master/packages/flakybot.
44+
# See https://github.com/googleapis/repo-automation-bots/tree/main/packages/flakybot.
4545
if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"continuous"* ]]; then
4646
cleanup() {
4747
chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot

.kokoro/test-samples-impl.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ for file in samples/**/requirements.txt; do
8080
EXIT=$?
8181

8282
# If this is a periodic build, send the test log to the FlakyBot.
83-
# See https://github.com/googleapis/repo-automation-bots/tree/master/packages/flakybot.
83+
# See https://github.com/googleapis/repo-automation-bots/tree/main/packages/flakybot.
8484
if [[ $KOKORO_BUILD_ARTIFACTS_SUBDIR = *"periodic"* ]]; then
8585
chmod +x $KOKORO_GFILE_DIR/linux_amd64/flakybot
8686
$KOKORO_GFILE_DIR/linux_amd64/flakybot

CONTRIBUTING.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ You'll have to create a development environment using a Git checkout:
5050
# Configure remotes such that you can pull changes from the googleapis/python-data-fusion
5151
# repository into your local repository.
5252
$ git remote add upstream git@github.com:googleapis/python-data-fusion.git
53-
# fetch and merge changes from upstream into master
53+
# fetch and merge changes from upstream into main
5454
$ git fetch upstream
55-
$ git merge upstream/master
55+
$ git merge upstream/main
5656

5757
Now your local repo is set up such that you will push changes to your GitHub
5858
repo, from which you can submit a pull request.
@@ -110,12 +110,12 @@ Coding Style
110110
variables::
111111

112112
export GOOGLE_CLOUD_TESTING_REMOTE="upstream"
113-
export GOOGLE_CLOUD_TESTING_BRANCH="master"
113+
export GOOGLE_CLOUD_TESTING_BRANCH="main"
114114

115115
By doing this, you are specifying the location of the most up-to-date
116116
version of ``python-data-fusion``. The the suggested remote name ``upstream``
117117
should point to the official ``googleapis`` checkout and the
118-
the branch should be the main branch on that remote (``master``).
118+
the branch should be the main branch on that remote (``main``).
119119

120120
- This repository contains configuration for the
121121
`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
209209
``README``. Due to the reStructuredText (``rst``) parser used by
210210
PyPI, relative links which will work on GitHub (e.g. ``CONTRIBUTING.rst``
211211
instead of
212-
``https://github.com/googleapis/python-data-fusion/blob/master/CONTRIBUTING.rst``)
212+
``https://github.com/googleapis/python-data-fusion/blob/main/CONTRIBUTING.rst``)
213213
may cause problems creating links or rendering the description.
214214

215215
.. _description on PyPI: https://pypi.org/project/google-cloud-data-fusion
@@ -234,7 +234,7 @@ We support:
234234

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

237-
.. _config: https://github.com/googleapis/python-data-fusion/blob/master/noxfile.py
237+
.. _config: https://github.com/googleapis/python-data-fusion/blob/main/noxfile.py
238238

239239

240240
We also explicitly decided to support Python 3 beginning with version 3.6.

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ data from siloed on-premises platforms.
1010
- `Product Documentation`_
1111

1212
.. |ga| image:: https://img.shields.io/badge/support-ga-gold.svg
13-
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability
13+
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
1414
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-data-fusion.svg
1515
:target: https://pypi.org/project/google-cloud-data-fusion/
1616
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-data-fusion.svg
@@ -80,4 +80,4 @@ Next Steps
8080
APIs that we cover.
8181

8282
.. _Cloud Data Fusion Product documentation: https://cloud.google.com/data-fusion/docs
83-
.. _README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
83+
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst

docs/conf.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@
7676
# The encoding of source files.
7777
# source_encoding = 'utf-8-sig'
7878

79-
# The master toctree document.
80-
master_doc = "index"
79+
# The main toctree document.
80+
root_doc = "index"
8181

8282
# General information about the project.
8383
project = "google-cloud-data-fusion"
@@ -280,7 +280,7 @@
280280
# author, documentclass [howto, manual, or own class]).
281281
latex_documents = [
282282
(
283-
master_doc,
283+
root_doc,
284284
"google-cloud-data-fusion.tex",
285285
"google-cloud-data-fusion Documentation",
286286
author,
@@ -315,7 +315,7 @@
315315
# (source start file, name, description, authors, manual section).
316316
man_pages = [
317317
(
318-
master_doc,
318+
root_doc,
319319
"google-cloud-data-fusion",
320320
"google-cloud-data-fusion Documentation",
321321
[author],
@@ -334,7 +334,7 @@
334334
# dir menu entry, description, category)
335335
texinfo_documents = [
336336
(
337-
master_doc,
337+
root_doc,
338338
"google-cloud-data-fusion",
339339
"google-cloud-data-fusion Documentation",
340340
author,

owlbot.py

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,38 @@
3939
# ----------------------------------------------------------------------------
4040

4141
s.shell.run(["nox", "-s", "blacken"], hide_output=False)
42+
43+
# ----------------------------------------------------------------------------
44+
# Main Branch migration
45+
# ----------------------------------------------------------------------------
46+
47+
s.replace(
48+
"*.rst",
49+
"master",
50+
"main"
51+
)
52+
53+
s.replace(
54+
"CONTRIBUTING.rst",
55+
"kubernetes/community/blob/main",
56+
"kubernetes/community/blob/master"
57+
)
58+
59+
s.replace(
60+
"docs/conf.py",
61+
"master",
62+
"main"
63+
)
64+
65+
s.replace(
66+
"docs/conf.py",
67+
"main_doc",
68+
"root_doc"
69+
)
70+
71+
s.replace(
72+
".kokoro/*",
73+
"master",
74+
"main"
75+
)
76+

0 commit comments

Comments
 (0)