From e4815741614cea6e8cba949629a2994b2bcc0cbc Mon Sep 17 00:00:00 2001 From: Ryan May Date: Mon, 22 Feb 2021 15:51:21 -0700 Subject: [PATCH] MNT: Update for rename of `master` branch to `main` --- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/pull_request_template.md | 4 ++-- .github/workflows/code-analysis.yml | 4 ++-- .github/workflows/docs-conda.yml | 2 +- .github/workflows/docs.yml | 6 +++--- .github/workflows/linting.yml | 2 +- .github/workflows/tests-conda.yml | 4 ++-- .github/workflows/tests-pypi.yml | 4 ++-- CONTRIBUTING.md | 12 ++++++------ README.md | 12 ++++++------ SUPPORT.md | 2 +- docs/conf.py | 4 ++-- docs/devel/infrastructureguide.rst | 4 ++-- docs/index.rst | 2 +- src/metpy/cbook.py | 2 +- 15 files changed, 33 insertions(+), 33 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 38e09ca01af..d32a8be17e3 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ contact_links: - name: Questions and Help - url: https://github.com/Unidata/MetPy/blob/master/SUPPORT.md#help-using-metpy + url: https://github.com/Unidata/MetPy/blob/main/SUPPORT.md#help-using-metpy about: "If you have a question or need some help, you will likely be better off turning to these resources." diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index cbcde39f74d..ce5f88b174f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ #### Description Of Changes @@ -17,4 +17,4 @@ request is merged. See https://github.com/blog/1506-closing-issues-via-pull-requ - [ ] Closes #xxxx - [ ] Tests added -- [ ] Fully documented \ No newline at end of file +- [ ] Fully documented diff --git a/.github/workflows/code-analysis.yml b/.github/workflows/code-analysis.yml index a36a12f587a..ddb81225b6b 100644 --- a/.github/workflows/code-analysis.yml +++ b/.github/workflows/code-analysis.yml @@ -2,10 +2,10 @@ name: "Code Analysis" on: push: - branches: [master, ] + branches: [main, ] pull_request: # The branches below must be a subset of the branches above - branches: [master] + branches: [main] schedule: - cron: '0 8 * * 6' diff --git a/.github/workflows/docs-conda.yml b/.github/workflows/docs-conda.yml index 4a59e6d825b..5c347a4920e 100644 --- a/.github/workflows/docs-conda.yml +++ b/.github/workflows/docs-conda.yml @@ -3,7 +3,7 @@ name: Build Docs (Conda) # We don't want pushes (or PRs) to gh-pages to kick anything off on: pull_request: - branches: [ master ] + branches: [ main ] jobs: # diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 73a0b305ef6..8364fce842f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,7 +4,7 @@ name: Build Docs on: push: branches: - - master + - main - '[0-9]+.[0-9]+.x' tags: - v[0-9]+.[0-9]+.[0-9]+ @@ -127,9 +127,9 @@ jobs: !docs/_static/*.pdf # This overrides the version "dev" with the proper version if we're building off a - # branch that's not master (which is confined to n.nn.x above) or on a tag. + # branch that's not main (which is confined to n.nn.x above) or on a tag. - name: Set doc version - if: ${{ github.event_name != 'push' || !contains(github.ref, 'master') }} + if: ${{ github.event_name != 'push' || !contains(github.ref, 'main') }} run: echo "DOC_VERSION=v$(python -c 'import metpy; print(metpy.__version__.rsplit(".", maxsplit=2)[0])')" >> $GITHUB_ENV - name: Upload to GitHub Pages diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index a69ae81dfbc..426b3ea757a 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -1,7 +1,7 @@ name: Linting on: push: - branches: [master] + branches: [main] pull_request: jobs: diff --git a/.github/workflows/tests-conda.yml b/.github/workflows/tests-conda.yml index b3ce220ac61..56c86c49899 100644 --- a/.github/workflows/tests-conda.yml +++ b/.github/workflows/tests-conda.yml @@ -3,9 +3,9 @@ name: Conda Tests # We don't want pushes (or PRs) to gh-pages to kick anything off on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] jobs: # diff --git a/.github/workflows/tests-pypi.yml b/.github/workflows/tests-pypi.yml index 73bc322f739..39b00359d76 100644 --- a/.github/workflows/tests-pypi.yml +++ b/.github/workflows/tests-pypi.yml @@ -3,9 +3,9 @@ name: PyPI Tests # We don't want pushes (or PRs) to gh-pages to kick anything off on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] jobs: # diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4f09d1eee9..d3ef5aebc47 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,7 @@ MetPy contributions. We're glad you're here! The goal is to maintain a diverse community that's pleasant for everyone. Please be considerate and respectful of others by following our -[code of conduct](https://github.com/Unidata/MetPy/blob/master/CODE_OF_CONDUCT.md). +[code of conduct](https://github.com/Unidata/MetPy/blob/main/CODE_OF_CONDUCT.md). Other items: @@ -100,17 +100,17 @@ terminal or your system. If you want to get back to the root environment, run ## Pull Requests The changes to the MetPy source (and documentation) should be made via GitHub pull requests -against ``master``, even for those with administration rights. While it's tempting to -make changes directly to ``master`` and push them up, it is better to make a pull request so +against ``main``, even for those with administration rights. While it's tempting to +make changes directly to ``main`` and push them up, it is better to make a pull request so that others can give feedback. If nothing else, this gives a chance for the automated tests to -run on the PR. This can eliminate "brown paper bag" moments with buggy commits on the master +run on the PR. This can eliminate "brown paper bag" moments with buggy commits on the main branch. During the Pull Request process, before the final merge, it's a good idea to rebase the branch and squash together smaller commits. It's not necessary to flatten the entire branch, but it can be nice to eliminate small fixes and get the merge down to logically arranged commits. This can also be used to hide sins from history--this is the only chance, since once it hits -``master``, it's there forever! +``main``, it's there forever! **Working on your first Pull Request?** You can learn how from this *free* video series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github), @@ -124,7 +124,7 @@ Push to your fork and [submit a pull request]( https://github.com/Unidata/metpy/ For the Pull Request to be accepted, you need to agree to the MetPy Contributor License Agreement (CLA). This will be handled automatically upon submission of a Pull Request. -See [here](https://github.com/Unidata/MetPy/blob/master/CLA.md) for more +See [here](https://github.com/Unidata/MetPy/blob/main/CLA.md) for more explanation and rationale behind MetPy's CLA. ## Source Code diff --git a/README.md b/README.md index 7c47ab7245f..e38b41660f4 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ MetPy [![PyPI Tests](https://github.com/Unidata/MetPy/workflows/PyPI%20Tests/badge.svg)](https://github.com/Unidata/MetPy/actions?query=workflow%3A%22PyPI+Tests%22) [![Conda Tests](https://github.com/Unidata/MetPy/workflows/Conda%20Tests/badge.svg)](https://github.com/Unidata/MetPy/actions?query=workflow%3A%22Conda+Tests%22) -[![Travis Build Status](https://travis-ci.com/Unidata/MetPy.svg?branch=master)](https://travis-ci.com/Unidata/MetPy) -[![Code Coverage Status](https://codecov.io/github/Unidata/MetPy/coverage.svg?branch=master)](https://codecov.io/github/Unidata/MetPy?branch=master) +[![Travis Build Status](https://travis-ci.com/Unidata/MetPy.svg?branch=main)](https://travis-ci.com/Unidata/MetPy) +[![Code Coverage Status](https://codecov.io/github/Unidata/MetPy/coverage.svg?branch=main)](https://codecov.io/github/Unidata/MetPy?branch=main) [![Codacy issues](https://api.codacy.com/project/badge/Grade/e1ea0937eb4942e79a44bc9bb2de616d)](https://www.codacy.com/app/dopplershift/MetPy) [![Code Climate](https://codeclimate.com/github/Unidata/MetPy/badges/gpa.svg)](https://codeclimate.com/github/Unidata/MetPy) @@ -34,14 +34,14 @@ Gallery](https://unidata.github.io/python-gallery/). We support Python >= 3.6. 0.12 is the first version to drop support for Python 2.7 in Fall 2019. See -[here](https://github.com/Unidata/MetPy/blob/master/docs/installguide.rst) for more +[here](https://github.com/Unidata/MetPy/blob/main/docs/installguide.rst) for more information. Need Help? ---------- Need help using MetPy? Found an issue? Have a feature request? Checkout our -[support page](https://github.com/Unidata/MetPy/blob/master/SUPPORT.md). +[support page](https://github.com/Unidata/MetPy/blob/main/SUPPORT.md). Important Links --------------- @@ -74,7 +74,7 @@ Code of Conduct --------------- We want everyone to feel welcome to contribute to MetPy and participate in discussions. In that -spirit please have a look at our [Code of Conduct](https://github.com/Unidata/MetPy/blob/master/CODE_OF_CONDUCT.md). +spirit please have a look at our [Code of Conduct](https://github.com/Unidata/MetPy/blob/main/CODE_OF_CONDUCT.md). Contributing ------------ @@ -97,7 +97,7 @@ includes giving feedback about the contribution process). Some of these contribu the most valuable to the project as a whole, because you're coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over. -For more information, please read the see the [contributing guide](https://github.com/Unidata/MetPy/blob/master/CONTRIBUTING.md). +For more information, please read the see the [contributing guide](https://github.com/Unidata/MetPy/blob/main/CONTRIBUTING.md). Philosophy ---------- diff --git a/SUPPORT.md b/SUPPORT.md index 751a7296a47..6e12aeb2a8c 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -33,4 +33,4 @@ Find a problem with MetPy? Looking for a feature we don't have? File an issue! We want everyone to feel welcome to contribute to MetPy and participate in discussions. In that spirit please have a look at our -[`code of conduct`](https://github.com/Unidata/MetPy/blob/master/CODE_OF_CONDUCT.md). +[`code of conduct`](https://github.com/Unidata/MetPy/blob/main/CODE_OF_CONDUCT.md). diff --git a/docs/conf.py b/docs/conf.py index 99a778cc086..e1869c5c5e4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,7 @@ # source_encoding = 'utf-8-sig' cur_date = datetime.utcnow() -# The master toctree document. +# The main toctree document. master_doc = 'index' # General information about the project. @@ -193,7 +193,7 @@ 'api_dir': 'api/generated', 'github_user': 'Unidata', 'github_repo': 'MetPy', - 'github_version': 'master', # Make changes to the master branch + 'github_version': 'main', # Make changes to the main branch } # Add any paths that contain custom themes here, relative to this directory. diff --git a/docs/devel/infrastructureguide.rst b/docs/devel/infrastructureguide.rst index ac1130e63f9..9bfba628ee7 100644 --- a/docs/devel/infrastructureguide.rst +++ b/docs/devel/infrastructureguide.rst @@ -31,7 +31,7 @@ extension, these scripts are executed and turned into a gallery of thumbnails. T extension also makes these scripts available as Jupyter notebooks. The documentation is hosted on `GitHub Pages `_. The docs are -built automatically and uploaded upon pushes or merges to GitHub. Commits to ``master`` end up +built automatically and uploaded upon pushes or merges to GitHub. Commits to ``main`` end up in our development version docs, while commits to versioned branches will update the docs for the corresponding version, which are located in the appropriately named subidrectory on the ``gh-pages`` branch. We only maintain docs at the minor level, not the bugfix one. @@ -60,7 +60,7 @@ The following services are used to track code quality: * `Codacy `_ * `Code Climate `_ -* `Scrutinizer `_ +* `Scrutinizer `_ We also maintain custom GitHub actions that automate additional tasks. Besides what's mentioned below as part of the release process, we have a script that automatically assigns diff --git a/docs/index.rst b/docs/index.rst index fd4c71840df..319d41e4cc9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,7 +15,7 @@ MetPy MetPy is a collection of tools in Python for reading, visualizing, and performing calculations with weather data. MetPy supports Python >= 3.6 and is freely available under a permissive -`open source license `_. +`open source license `_. If you're new to MetPy, check out our :doc:`Getting Started ` guide. diff --git a/src/metpy/cbook.py b/src/metpy/cbook.py index 3b3f72527b1..85c5c26ac16 100644 --- a/src/metpy/cbook.py +++ b/src/metpy/cbook.py @@ -15,7 +15,7 @@ path=pooch.os_cache('metpy'), base_url='https://github.com/Unidata/MetPy/raw/{version}/staticdata/', version='v' + __version__, - version_dev='master') + version_dev='main') # Check if we have the data available directly from a git checkout, either from the # TEST_DATA_DIR variable, or looking relative to the path of this module's file. Use this