Skip to content
Permalink
Browse files
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
  • Loading branch information
dandhlee committed Aug 24, 2021
1 parent e1ee3ff commit 7edab48370aeb6194f864bc2d402b8ffa7761a51
Showing with 50 additions and 15 deletions.
  1. +1 −1 .kokoro/build.sh
  2. +1 −1 .kokoro/test-samples-impl.sh
  3. +6 −6 CONTRIBUTING.rst
  4. +2 −2 README.rst
  5. +5 −5 docs/conf.py
  6. +35 −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-data-fusion
# repository into your local repository.
$ git remote add upstream git@github.com:googleapis/python-data-fusion.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-data-fusion``. 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-data-fusion/blob/master/CONTRIBUTING.rst``)
``https://github.com/googleapis/python-data-fusion/blob/main/CONTRIBUTING.rst``)
may cause problems creating links or rendering the description.

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

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

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


We also explicitly decided to support Python 3 beginning with version 3.6.
@@ -10,7 +10,7 @@ data from siloed on-premises platforms.
- `Product Documentation`_

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

.. _Cloud Data Fusion Product documentation: https://cloud.google.com/data-fusion/docs
.. _README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
@@ -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-data-fusion"
@@ -280,7 +280,7 @@
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(
master_doc,
root_doc,
"google-cloud-data-fusion.tex",
"google-cloud-data-fusion Documentation",
author,
@@ -315,7 +315,7 @@
# (source start file, name, description, authors, manual section).
man_pages = [
(
master_doc,
root_doc,
"google-cloud-data-fusion",
"google-cloud-data-fusion Documentation",
[author],
@@ -334,7 +334,7 @@
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
root_doc,
"google-cloud-data-fusion",
"google-cloud-data-fusion Documentation",
author,
@@ -39,3 +39,38 @@
# ----------------------------------------------------------------------------

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"
)

0 comments on commit 7edab48

Please sign in to comment.