From 5cdb20229b2783c8b47f3b4a738dcd9d16a7c5b5 Mon Sep 17 00:00:00 2001 From: jakirkham Date: Mon, 23 May 2022 14:12:52 -0700 Subject: [PATCH] Move `master` to `main` (#1033) --- .github/workflows/Pre-commit-hooks.yml | 4 ++-- .github/workflows/minimal.yml | 4 ++-- .github/workflows/python-package.yml | 4 ++-- .github/workflows/windows-testing.yml | 4 ++-- README.md | 8 ++++---- codecov.yml | 2 +- docs/conf.py | 10 +++++----- docs/contributing.rst | 22 +++++++++++----------- docs/index.rst | 4 ++-- docs/release.rst | 2 +- docs/tutorial.rst | 2 +- 11 files changed, 33 insertions(+), 33 deletions(-) diff --git a/.github/workflows/Pre-commit-hooks.yml b/.github/workflows/Pre-commit-hooks.yml index 05ed509c5..7955cb239 100644 --- a/.github/workflows/Pre-commit-hooks.yml +++ b/.github/workflows/Pre-commit-hooks.yml @@ -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: diff --git a/.github/workflows/minimal.yml b/.github/workflows/minimal.yml index a87e374de..fc9c048af 100644 --- a/.github/workflows/minimal.yml +++ b/.github/workflows/minimal.yml @@ -4,9 +4,9 @@ name: Minimal installation on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] jobs: minimum_build: diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml index 37000350c..c62d40721 100644 --- a/.github/workflows/python-package.yml +++ b/.github/workflows/python-package.yml @@ -5,9 +5,9 @@ name: Linux Testing on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] jobs: build: diff --git a/.github/workflows/windows-testing.yml b/.github/workflows/windows-testing.yml index 8c249a4db..37eea5df7 100644 --- a/.github/workflows/windows-testing.yml +++ b/.github/workflows/windows-testing.yml @@ -5,9 +5,9 @@ name: Python package on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] jobs: windows: diff --git a/README.md b/README.md index de20ebbc3..99b2393ad 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
-
+
# Zarr @@ -31,7 +31,7 @@ License - + license @@ -40,7 +40,7 @@ Build Status - travis build status + travis build status @@ -48,7 +48,7 @@ Coverage - coverage + coverage diff --git a/codecov.yml b/codecov.yml index e90b9e9fe..e9b99c821 100644 --- a/codecov.yml +++ b/codecov.yml @@ -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" diff --git a/docs/conf.py b/docs/conf.py index f3e2e1327..2bbd3ffb6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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' @@ -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'), ] @@ -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) ] @@ -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'), ] diff --git a/docs/contributing.rst b/docs/contributing.rst index adadb323d..f433f1bc0 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -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 @@ -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. @@ -206,7 +206,7 @@ Documentation Docstrings for user-facing classes and functions should follow the `numpydoc -`_ +`_ 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, @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -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:: diff --git a/docs/index.rst b/docs/index.rst index d75c159fd..5343dea0e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 @@ -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 diff --git a/docs/release.rst b/docs/release.rst index 7e68491aa..50ff7f98a 100644 --- a/docs/release.rst +++ b/docs/release.rst @@ -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 - `_ + `_ with extended examples and performance benchmarks. :issue:`78`, :issue:`89`, :issue:`112`, :issue:`172`. diff --git a/docs/tutorial.rst b/docs/tutorial.rst index b40896c78..1cd0387a7 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -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 `_), calling ``tree()`` will generate an interactive tree representation, see the `repr_tree.ipynb notebook -`_ +`_ for more examples. .. _tutorial_attrs: