Skip to content

Commit

Permalink
Move master to main (#1033)
Browse files Browse the repository at this point in the history
  • Loading branch information
jakirkham committed May 23, 2022
1 parent fd979fb commit 5cdb202
Show file tree
Hide file tree
Showing 11 changed files with 33 additions and 33 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/Pre-commit-hooks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ name: pre-commit

# Controls when the workflow will run
on:
# Triggers the workflow pull request events but only for the master branch
# Triggers the workflow pull request events but only for the main branch
pull_request:
push:
branches: [master]
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/minimal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ name: Minimal installation

on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
branches: [ master ]
branches: [ main ]

jobs:
minimum_build:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ name: Linux Testing

on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
branches: [ master ]
branches: [ main ]

jobs:
build:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/windows-testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ name: Python package

on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
branches: [ master ]
branches: [ main ]

jobs:
windows:
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<img src="https://raw.githubusercontent.com/zarr-developers/community/master/logos/logo2.png"><br>
<img src="https://raw.githubusercontent.com/zarr-developers/community/main/logos/logo2.png"><br>
</div>

# Zarr
Expand Down Expand Up @@ -31,7 +31,7 @@
<tr>
<td>License</td>
<td>
<a href="https://github.com/zarr-developers/zarr-python/blob/master/LICENSE">
<a href="https://github.com/zarr-developers/zarr-python/blob/main/LICENSE">
<img src="https://img.shields.io/pypi/l/zarr.svg" alt="license" />
</a>
</td>
Expand All @@ -40,15 +40,15 @@
<td>Build Status</td>
<td>
<a href="https://travis-ci.org/zarr-developers/zarr-python">
<img src="https://travis-ci.org/zarr-developers/zarr-python.svg?branch=master" alt="travis build status" />
<img src="https://travis-ci.org/zarr-developers/zarr-python.svg?branch=main" alt="travis build status" />
</a>
</td>
</tr>
<tr>
<td>Coverage</td>
<td>
<a href="https://codecov.io/gh/zarr-developers/zarr-python">
<img src="https://codecov.io/gh/zarr-developers/zarr-python/branch/master/graph/badge.svg"/ alt="coverage">
<img src="https://codecov.io/gh/zarr-developers/zarr-python/branch/main/graph/badge.svg"/ alt="coverage">
</a>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ comment:
behavior: default
require_changes: true # if true: only post the comment if coverage changes
branches: # branch names that can post comment
- "master"
- "main"
10 changes: 5 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,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'

# General information about the project.
project = 'zarr'
Expand Down Expand Up @@ -245,7 +245,7 @@ def setup(app):
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'zarr.tex', 'zarr Documentation',
(main_doc, 'zarr.tex', 'zarr Documentation',
'Zarr Developers', 'manual'),
]

Expand Down Expand Up @@ -275,7 +275,7 @@ def setup(app):
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'zarr', 'zarr Documentation',
(main_doc, 'zarr', 'zarr Documentation',
[author], 1)
]

Expand All @@ -289,7 +289,7 @@ def setup(app):
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'zarr', 'zarr Documentation',
(main_doc, 'zarr', 'zarr Documentation',
author, 'zarr', 'One line description of project.',
'Miscellaneous'),
]
Expand Down
22 changes: 11 additions & 11 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,9 @@ report the bug or propose the feature you'd like to add.
It's best to synchronize your fork with the upstream repository, then create a
new, separate branch for each piece of work you want to do. E.g.::

git checkout master
git checkout main
git fetch upstream
git rebase upstream/master
git rebase upstream/main
git push
git checkout -b shiny-new-feature
git push -u origin shiny-new-feature
Expand All @@ -120,18 +120,18 @@ this branch specific to one bug or feature so it is clear what the branch brings
Zarr.

To update this branch with latest code from Zarr, you can retrieve the changes from
the master branch and perform a rebase::
the main branch and perform a rebase::

git fetch upstream
git rebase upstream/master
git rebase upstream/main

This will replay your commits on top of the latest Zarr git master. If this leads to
This will replay your commits on top of the latest Zarr git main. If this leads to
merge conflicts, these need to be resolved before submitting a pull request.
Alternatively, you can merge the changes in from upstream/master instead of rebasing,
Alternatively, you can merge the changes in from upstream/main instead of rebasing,
which can be simpler::

git fetch upstream
git merge upstream/master
git merge upstream/main

Again, any conflicts need to be resolved before submitting a pull request.

Expand Down Expand Up @@ -206,7 +206,7 @@ Documentation

Docstrings for user-facing classes and functions should follow the
`numpydoc
<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_
<https://github.com/numpy/numpy/blob/main/doc/HOWTO_DOCUMENT.rst.txt>`_
standard, including sections for Parameters and Examples. All examples
should run and pass as doctests under Python 3.8. To run doctests,
activate your development environment, install optional requirements,
Expand Down Expand Up @@ -242,7 +242,7 @@ one core developers before being merged. Ideally, pull requests submitted by a c
should be reviewed and approved by at least one other core developers before being merged.

Pull requests should not be merged until all CI checks have passed (GitHub Actions
Codecov) against code that has had the latest master merged in.
Codecov) against code that has had the latest main merged in.

Compatibility and versioning policies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -337,9 +337,9 @@ Release procedure
Most of the release process is now handled by github workflow which should
automatically push a release to PyPI if a tag is pushed.

Checkout and update the master branch::
Checkout and update the main branch::

$ git checkout master
$ git checkout main
$ git pull

Verify all tests pass on all supported Python versions, and docs build::
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. zarr documentation master file, created by
.. zarr documentation main file, created by
sphinx-quickstart on Mon May 2 21:40:09 2016.
Zarr
Expand Down Expand Up @@ -42,7 +42,7 @@ Alternatively, install Zarr via conda::
$ conda install -c conda-forge zarr

To install the latest development version of Zarr, you can use pip with the
latest GitHub master::
latest GitHub main::

$ pip install git+https://github.com/zarr-developers/zarr-python.git

Expand Down
2 changes: 1 addition & 1 deletion docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -893,7 +893,7 @@ Enhancements
properties that enable a selection of items in an array to be retrieved or
updated. See the :ref:`tutorial_indexing` tutorial section for more
information. There is also a `notebook
<https://github.com/zarr-developers/zarr-python/blob/master/notebooks/advanced_indexing.ipynb>`_
<https://github.com/zarr-developers/zarr-python/blob/main/notebooks/advanced_indexing.ipynb>`_
with extended examples and performance benchmarks. :issue:`78`, :issue:`89`,
:issue:`112`, :issue:`172`.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,7 @@ Groups also have the :func:`zarr.hierarchy.Group.tree` method, e.g.::
If you're using Zarr within a Jupyter notebook (requires
`ipytree <https://github.com/QuantStack/ipytree>`_), calling ``tree()`` will generate an
interactive tree representation, see the `repr_tree.ipynb notebook
<http://nbviewer.jupyter.org/github/zarr-developers/zarr-python/blob/master/notebooks/repr_tree.ipynb>`_
<http://nbviewer.jupyter.org/github/zarr-developers/zarr-python/blob/main/notebooks/repr_tree.ipynb>`_
for more examples.

.. _tutorial_attrs:
Expand Down

0 comments on commit 5cdb202

Please sign in to comment.