Rename master to main (#1076)

mfeurer · PGijsbers · web-flow · commit bb17e72d1866 · 2021-05-17T10:30:35.000+02:00
* rename master to main

* update changelog

* fix documentation building script

* rename master to main in all remaining docs

* drop badges

Co-authored-by: PGijsbers &lt;p.gijsbers@tue.nl&gt;
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -22,19 +22,19 @@ jobs:
         cd doc
         make linkcheck
     - name: Pull latest gh-pages
-      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
+      if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
       run: |
         cd ..
         git clone https://github.com/openml/openml-python.git --branch gh-pages --single-branch gh-pages
     - name: Copy new doc into gh-pages
-      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
+      if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
       run: |
         branch_name=${GITHUB_REF##*/}
         cd ../gh-pages
         rm -rf $branch_name
         cp -r ../openml-python/doc/build/html $branch_name
     - name: Push to gh-pages
-      if: (contains(github.ref, 'develop') || contains(github.ref, 'master')) && github.event_name == 'push'
+      if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
       run: |
         last_commit=$(git log --pretty=format:"%an: %s")
         cd ../gh-pages
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 This document describes the workflow on how to contribute to the openml-python package.
 If you are interested in connecting a machine learning package with OpenML (i.e.
-write an openml-python extension) or want to find other ways to contribute, see [this page](https://openml.github.io/openml-python/master/contributing.html#contributing).
+write an openml-python extension) or want to find other ways to contribute, see [this page](https://openml.github.io/openml-python/main/contributing.html#contributing).
 
 Scope of the package
 --------------------
@@ -20,7 +20,7 @@ keep the number of potential installation dependencies as low as possible.
 Therefore, the connection to other machine learning libraries such as
 *pytorch*, *keras* or *tensorflow* should not be done directly inside this
 package, but in a separate package using the OpenML Python connector.
-More information on OpenML Python connectors can be found [here](https://openml.github.io/openml-python/master/contributing.html#contributing).
+More information on OpenML Python connectors can be found [here](https://openml.github.io/openml-python/main/contributing.html#contributing).
 
 Reporting bugs
 --------------
@@ -100,7 +100,7 @@ local disk:
    $ git checkout -b feature/my-feature
    ```
 
-   Always use a ``feature`` branch. It's good practice to never work on the ``master`` or ``develop`` branch! 
+   Always use a ``feature`` branch. It's good practice to never work on the ``main`` or ``develop`` branch! 
    To make the nature of your pull request easily visible, please prepend the name of the branch with the type of changes you want to merge, such as ``feature`` if it contains a new feature, ``fix`` for a bugfix, ``doc`` for documentation and ``maint`` for other maintenance on the package.
 
 4. Develop the feature on your feature branch. Add changed files using ``git add`` and then ``git commit`` files:
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,6 @@
 <!--
 Thanks for contributing a pull request to the OpenML python connector! Please ensure you have taken a look at
-the contribution guidelines: https://github.com/openml/openml-python/blob/master/CONTRIBUTING.md#Contributing-Pull-Requests
+the contribution guidelines: https://github.com/openml/openml-python/blob/main/CONTRIBUTING.md#Contributing-Pull-Requests
 
 Please make sure that:
 
diff --git a/README.md b/README.md
@@ -13,18 +13,6 @@ It can be used to download or upload OpenML data such as datasets and machine le
 
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 
-Master branch:
-
-[![Build Status](https://travis-ci.org/openml/openml-python.svg?branch=master)](https://travis-ci.org/openml/openml-python)
-[![Build status](https://ci.appveyor.com/api/projects/status/blna1eip00kdyr25?svg=true)](https://ci.appveyor.com/project/OpenML/openml-python)
-[![Coverage Status](https://coveralls.io/repos/github/openml/openml-python/badge.svg?branch=master)](https://coveralls.io/github/openml/openml-python?branch=master)
-
-Development branch:
-
-[![Build Status](https://travis-ci.org/openml/openml-python.svg?branch=develop)](https://travis-ci.org/openml/openml-python)
-[![Build status](https://ci.appveyor.com/api/projects/status/blna1eip00kdyr25/branch/develop?svg=true)](https://ci.appveyor.com/project/OpenML/openml-python/branch/develop)
-[![Coverage Status](https://coveralls.io/repos/github/openml/openml-python/badge.svg?branch=develop)](https://coveralls.io/github/openml/openml-python?branch=develop)
-
 ## Citing OpenML-Python
 
 If you use OpenML-Python in a scientific publication, we would appreciate a reference to the
@@ -62,4 +50,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- prettier-ignore-end -->
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
diff --git a/doc/contributing.rst b/doc/contributing.rst
@@ -10,7 +10,7 @@ Contribution to the OpenML package is highly appreciated in all forms.
 In particular, a few ways to contribute to openml-python are:
 
  * A direct contribution to the package, by means of improving the
-   code, documentation or examples. To get started, see `this file <https://github.com/openml/openml-python/blob/master/CONTRIBUTING.md>`_
+   code, documentation or examples. To get started, see `this file <https://github.com/openml/openml-python/blob/main/CONTRIBUTING.md>`_
    with details on how to set up your environment to develop for openml-python.
 
  * A contribution to an openml-python extension. An extension package allows OpenML to interface
@@ -19,13 +19,13 @@ In particular, a few ways to contribute to openml-python are:
    For more information, see the :ref:`extensions` below.
 
  * Bug reports. If something doesn't work for you or is cumbersome, please open a new issue to let
-   us know about the problem. See `this section <https://github.com/openml/openml-python/blob/master/CONTRIBUTING.md#user-content-reporting-bugs>`_.
+   us know about the problem. See `this section <https://github.com/openml/openml-python/blob/main/CONTRIBUTING.md#user-content-reporting-bugs>`_.
 
  * `Cite OpenML <https://www.openml.org/cite>`_ if you use it in a scientific publication.
 
  * Visit one of our `hackathons <https://meet.openml.org/>`_.
 
- * Contribute to another OpenML project, such as `the main OpenML project <https://github.com/openml/OpenML/blob/master/CONTRIBUTING.md>`_.
+ * Contribute to another OpenML project, such as `the main OpenML project <https://github.com/openml/OpenML/blob/main/CONTRIBUTING.md>`_.
 
 .. _extensions:
 
diff --git a/doc/progress.rst b/doc/progress.rst
@@ -8,9 +8,11 @@ Changelog
 
 0.12.2
 ~~~~~~
+
 * ADD #1065: Add a ``retry_policy`` configuration option that determines the frequency and number of times to attempt to retry server requests.
 * ADD #1075: A docker image is now automatically built on a push to develop. It can be used to build docs or run tests in an isolated environment.
 * DOC: Fixes a few broken links in the documentation.
+* MAINT: Rename `master` brach to ` main` branch.
 * MAINT/DOC: Automatically check for broken external links when building the documentation.
 * MAINT/DOC: Fail documentation building on warnings. This will make the documentation building
   fail if a reference cannot be found (i.e. an internal link is broken).
diff --git a/doc/usage.rst b/doc/usage.rst
@@ -40,7 +40,8 @@ directory of the user and is called config. It consists of ``key = value`` pairs
 which are separated by newlines. The following keys are defined:
 
 * apikey:
-    * required to access the server. The `OpenML setup <https://openml.github.io/openml-python/master/examples/20_basic/introduction_tutorial.html#authentication>`_ describes how to obtain an API key.
+    * required to access the server. The :ref:`sphx_glr_examples_20_basic_introduction_tutorial.py`
+      describes how to obtain an API key.
 
 * server:
     * default: ``http://www.openml.org``. Alternatively, use ``test.openml.org`` for the test server.
@@ -76,11 +77,8 @@ Docker
 
 It is also possible to try out the latest development version of ``openml-python`` with docker:
 
-
     ``docker run -it openml/openml-python``
 
-
-
 See the `openml-python docker documentation <https://github.com/openml/openml-python/blob/main/docker/readme.md>`_ for more information.
 
 ~~~~~~~~~~~~
diff --git a/docker/startup.sh b/docker/startup.sh
@@ -59,7 +59,7 @@ fi
 
 source /omlp/venv/bin/activate
 cd $code_dir
-# The most recent ``master`` is already installed, but we want to update any outdated dependencies
+# The most recent ``main`` is already installed, but we want to update any outdated dependencies
 pip install -e .[test,examples,docs,examples_unix]
 
 if [ "$1" == "test" ]; then
diff --git a/examples/30_extended/custom_flow_.py b/examples/30_extended/custom_flow_.py
@@ -4,7 +4,7 @@
 ================================
 
 The most convenient way to create a flow for your machine learning workflow is to generate it
-automatically as described in the `Obtain Flow IDs <https://openml.github.io/openml-python/master/examples/30_extended/flow_id_tutorial.html#sphx-glr-examples-30-extended-flow-id-tutorial-py>`_ tutorial.  # noqa E501
+automatically as described in the :ref:`sphx_glr_examples_30_extended_flow_id_tutorial.py` tutorial.
 However, there are scenarios where this is not possible, such
 as when the flow uses a framework without an extension or when the flow is described by a script.
 
@@ -31,7 +31,7 @@
 # 1. Defining the flow
 # ====================
 # The first step is to define all the hyperparameters of your flow.
-# The API pages feature a descriptions of each variable of the `OpenMLFlow <https://openml.github.io/openml-python/master/generated/openml.OpenMLFlow.html#openml.OpenMLFlow>`_.  # noqa E501
+# The API pages feature a descriptions of each variable of the :class:`openml.flows.OpenMLFlow`.
 # Note that `external version` and `name` together uniquely identify a flow.
 #
 # The AutoML Benchmark runs AutoML systems across a range of tasks.
diff --git a/examples/40_paper/2015_neurips_feurer_example.py b/examples/40_paper/2015_neurips_feurer_example.py
@@ -4,7 +4,7 @@
 
 A tutorial on how to get the datasets used in the paper introducing *Auto-sklearn* by Feurer et al..
 
-Auto-sklearn website: https://automl.github.io/auto-sklearn/master/
+Auto-sklearn website: https://automl.github.io/auto-sklearn/
 
 Publication
 ~~~~~~~~~~~
diff --git a/openml/cli.py b/openml/cli.py
@@ -331,7 +331,7 @@ def main() -> None:
     parser_configure = subparsers.add_parser(
         "configure",
         description="Set or read variables in your configuration file. For more help also see "
-        "'https://openml.github.io/openml-python/master/usage.html#configuration'.",
+        "'https://openml.github.io/openml-python/main/usage.html#configuration'.",
     )
 
     configurable_fields = [f for f in config._defaults if f not in ["max_retries"]]
