Merge pull request #1529 from manics/master-main

Rename master branch to main

Author: consideRatio

.github/workflows/publish.yml

@@ -33,7 +33,7 @@ jobs:
   #
   Publish:
     runs-on: ubuntu-latest
-    if: startsWith(github.ref, 'refs/tags/') || (github.ref == 'refs/heads/main') || (github.ref == 'refs/heads/master')
+    if: startsWith(github.ref, 'refs/tags/') || (github.ref == 'refs/heads/main')
     steps:
       - uses: actions/checkout@v3
         with:

CONTRIBUTING.md

@@ -283,7 +283,7 @@ You are assumed to have a modern version of [Python](https://www.python.org/),
 1. Install `helm` - the Kubernetes package manager.
 
    ```bash
-   curl -sf https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
+   curl -sf https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
    ```
 
    Here are the [official installation instructions](https://helm.sh/docs/intro/install/).
@@ -368,7 +368,7 @@ it with another version from the [JupyterHub Helm chart
 repository](https://jupyterhub.github.io/helm-chart/).
 
 Use the [JupyterHub Helm chart's
-changelog](https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/master/CHANGELOG.md)
+changelog](https://github.com/jupyterhub/zero-to-jupyterhub-k8s/blob/HEAD/CHANGELOG.md)
 to prepare for breaking changes associated with the version bump.
 
 ### Releasing

README.md

@@ -6,7 +6,7 @@
 [![GitHub](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/jupyterhub/binderhub/issues)
 [![Discourse](https://img.shields.io/badge/help_forum-discourse-blue.svg)](https://discourse.jupyter.org/c/binder/binderhub)
 [![Gitter](https://img.shields.io/badge/social_chat-gitter-blue.svg)](https://gitter.im/jupyterhub/binder)
-[![Contribute](https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter)](https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md)
+[![Contribute](https://img.shields.io/badge/I_want_to_contribute!-grey?logo=jupyter)](https://github.com/jupyterhub/binderhub/blob/HEAD/CONTRIBUTING.md)
 
 ## What is BinderHub?
 
@@ -44,7 +44,7 @@ To contribute to the BinderHub project you can work on:
 
 To see how to build the documentation, edit the user interface or modify
 the code see [the contribution
-guide](https://github.com/jupyterhub/binderhub/blob/master/CONTRIBUTING.md).
+guide](https://github.com/jupyterhub/binderhub/blob/HEAD/CONTRIBUTING.md).
 
 ## Installation
 

binderhub/repoproviders.py

@@ -38,8 +38,8 @@ def tokenize_spec(spec):
     spec_parts = spec.split("/", 2)  # allow ref to contain "/"
     if len(spec_parts) != 3:
         msg = f'Spec is not of the form "user/repo/ref", provided: "{spec}".'
-        if len(spec_parts) == 2 and spec_parts[-1] != "master":
-            msg += f' Did you mean "{spec}/master"?'
+        if len(spec_parts) == 2 and spec_parts[-1] not in ("main", "master"):
+            msg += f' Did you mean "{spec}/main"?'
         raise ValueError(msg)
 
     return spec_parts
@@ -456,8 +456,8 @@ class GitRepoProvider(RepoProvider):
     <url-escaped-namespace>/<resolved_ref>
 
     eg:
-    https%3A%2F%2Fgithub.com%2Fjupyterhub%2Fzero-to-jupyterhub-k8s/master
-    https%3A%2F%2Fgithub.com%2Fjupyterhub%2Fzero-to-jupyterhub-k8s/f7f3ff6d1bf708bdc12e5f10e18b2a90a4795603
+    https%3A%2F%2Fgithub.com%2Fbinder-examples%2Fconda/main
+    https%3A%2F%2Fgithub.com%2Fbinder-examples%2Fconda/034931911e853252322f2309f1246a4f1076fd7d
 
     This provider is typically used if you are deploying binderhub yourself and you require access to repositories that
     are not in one of the supported providers.
@@ -957,6 +957,7 @@ class GistRepoProvider(GitHubRepoProvider):
     The ref is optional, valid values are
         - a full sha1 of a ref in the history
         - master
+        - HEAD for the default branch
 
     If master or no ref is specified the latest revision will be used.
     """

binderhub/tests/test_repoproviders.py

@@ -367,7 +367,7 @@ def test_spec_with_no_suggestion(self):
 
     def test_spec_with_suggestion(self):
         spec = "short/suggestion"
-        error = f'Did you mean "{spec}/master"?'
+        error = f'Did you mean "{spec}/main"?'
         with self.assertRaisesRegex(ValueError, error):
             user, repo, unresolved_ref = tokenize_spec(spec)
 

ci/common

@@ -4,7 +4,7 @@
 setup_helm() {
     helm_version="${1}"
     echo "setup helm ${helm_version}"
-    curl -sf https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | DESIRED_VERSION="${helm_version}" bash
+    curl -sf https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | DESIRED_VERSION="${helm_version}" bash
 }
 
 await_jupyterhub() {

doc/conf.py

@@ -57,8 +57,8 @@
 # You can specify multiple suffix as a list of string:
 source_suffix = [".rst", ".md"]
 
-# The master toctree document.
-master_doc = "index"
+# The root toctree document.
+root_doc = "index"
 
 # Set the default role so we can use `foo` instead of ``foo``
 default_role = "literal"
@@ -107,7 +107,7 @@
 html_context = {
     "github_user": "jupyterhub",
     "github_repo": "binderhub",
-    "github_version": "master",
+    "github_version": "main",
     "doc_path": "doc",
 }
 
@@ -145,15 +145,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, "BinderHub.tex", "BinderHub Documentation", "Yuvi Panda", "manual"),
+    (root_doc, "BinderHub.tex", "BinderHub Documentation", "Yuvi Panda", "manual"),
 ]
 
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "binderhub", "BinderHub Documentation", [author], 1)]
+man_pages = [(root_doc, "binderhub", "BinderHub Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -163,7 +163,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (
-        master_doc,
+        root_doc,
         "BinderHub",
         "BinderHub Documentation",
         author,

doc/customizing.rst

@@ -72,7 +72,7 @@ Firstly assume that you have a Git repo ``binderhub_custom_files`` which holds y
         └── page.html
 
 where ``page.html`` extends the `base page.html
-<https://github.com/jupyterhub/binderhub/blob/master/binderhub/templates/page.html>`_ and
+<https://github.com/jupyterhub/binderhub/blob/HEAD/binderhub/templates/page.html>`_ and
 updates only the source url of the logo in order to use your custom logo::
 
     {% extends "templates/page.html" %}
@@ -82,7 +82,7 @@ updates only the source url of the logo in order to use your custom logo::
 .. note::
 
     If you want to extend `any other base template
-    <https://github.com/jupyterhub/binderhub/tree/master/binderhub/templates>`_,
+    <https://github.com/jupyterhub/binderhub/tree/HEAD/binderhub/templates>`_,
     you have to include ``{% extends "templates/<base_template_name>.html" %}``
     in the beginning of your custom template.
     It is also possible to have completely new template instead of extending the base one.
@@ -98,7 +98,7 @@ To do that add the following into your ``config.yaml``::
         args:
           - clone
           - --single-branch
-          - --branch=master
+          - --branch=main
           - --depth=1
           - --
           - <repo_url>

doc/developer/repoproviders.rst

@@ -24,7 +24,7 @@ Currently supported providers, their prefixes and specs are:
     | GitHub     | ``gh``             | ``<user>/<repo>/<commit-sha-or-tag-or-branch>``             | `GitHub <https://github.com/>`_ is a website for hosting and sharing git repositories.                                                    |
     +------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
     | GitLab     | ``gl``             | ``<url-escaped-namespace>/<unresolved_ref>``                | `GitLab <https://about.gitlab.com/>`_ offers hosted as well as self-hosted git repositories.                                              |
-    |            |                    | (e.g. ``group%2Fproject%2Frepo/master``)                    |                                                                                                                                           |
+    |            |                    | (e.g. ``group%2Fproject%2Frepo/main``)                    |                                                                                                                                           |
     +------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
     | Gist       | ``gist``           | ``<github-username>/<gist-id><commit-sha-or-tag>``          | `Gists <https://gist.github.com/>`_ are small collections of files stored on GitHub. They behave like lightweight repositories.           |
     +------------+--------------------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
@@ -47,16 +47,16 @@ a BinderHub deployment to fetch repositories from new locations
 on the web. Doing so involves defining your own RepoProvider sub-class
 and modifying a set of methods/attributes to interface with the online
 provider to which you are providing access. It also often involves
-`building a new repo2docker content provider <https://github.com/jupyter/repo2docker/tree/master/repo2docker/contentproviders>`_.
+`building a new repo2docker content provider <https://github.com/jupyter/repo2docker/tree/HEAD/repo2docker/contentproviders>`_.
 
 In order to extend the supported repository providers,
 follow these instructions. We'll provide example links for each step to a
 recent `BinderHub pull-request <https://github.com/jupyterhub/binderhub/pull/969>`_
 that implements the ``DataverseProvider`` class.
 
-#. Review the `repoprovider module <https://github.com/jupyterhub/binderhub/blob/master/binderhub/repoproviders.py>`_.
+#. Review the `repoprovider module <https://github.com/jupyterhub/binderhub/blob/HEAD/binderhub/repoproviders.py>`_.
    This shows a number of example repository providers.
-#. Check whether repo2docker has a `ContentProvider class <https://github.com/jupyter/repo2docker/tree/master/repo2docker/contentproviders>`_
+#. Check whether repo2docker has a `ContentProvider class <https://github.com/jupyter/repo2docker/tree/HEAD/repo2docker/contentproviders>`_
    that will work with your repository provider. If not, then you'll need to create one first.
 #. Create a new class that sub-classes the ``RepoProvider`` class.
    Define your own methods for actions that are repository provider-specific.

doc/eventlogging.rst

@@ -55,4 +55,4 @@ Schemas:
 - `version 1 <https://github.com/jupyterhub/binderhub/blob/3da0f0c07eeea1b4517e5c7d1ec4a3166b3ca11c/binderhub/event-schemas/launch.json>`_
 - `version 2 <https://github.com/jupyterhub/binderhub/blob/5cc0f496cac98d6c9b7d645e6fb236fd1e5277f4/binderhub/event-schemas/launch.json>`_
 - `version 3 <https://github.com/jupyterhub/binderhub/blob/3bfee95f7c53d16604ea29f46b7e7c5aa1b49a63/binderhub/event-schemas/launch.json>`_
-- `version 4 <https://github.com/jupyterhub/binderhub/blob/master/binderhub/event-schemas/launch.json>`_
+- `version 4 <https://github.com/jupyterhub/binderhub/blob/HEAD/binderhub/event-schemas/launch.json>`_