Skip to content

Commit df8055e

Browse files
authored
Fix the things that broke when we renamed master -> main (#1605)
* bulk rename master -> main * a bit of cleanup * also update the benchmarks config
1 parent c78b50f commit df8055e

File tree

13 files changed

+35
-35
lines changed

13 files changed

+35
-35
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
- [ ] Closes #xxxx
44
- [ ] I am familiar with the [contributing guidelines](https://pvlib-python.readthedocs.io/en/latest/contributing.html)
55
- [ ] Tests added
6-
- [ ] Updates entries in [`docs/sphinx/source/reference`](https://github.com/pvlib/pvlib-python/blob/master/docs/sphinx/source/reference) for API changes.
7-
- [ ] Adds description and name entries in the appropriate "what's new" file in [`docs/sphinx/source/whatsnew`](https://github.com/pvlib/pvlib-python/tree/master/docs/sphinx/source/whatsnew) for all changes. Includes link to the GitHub Issue with `` :issue:`num` `` or this Pull Request with `` :pull:`num` ``. Includes contributor name and/or GitHub username (link with `` :ghuser:`user` ``).
6+
- [ ] Updates entries in [`docs/sphinx/source/reference`](https://github.com/pvlib/pvlib-python/blob/main/docs/sphinx/source/reference) for API changes.
7+
- [ ] Adds description and name entries in the appropriate "what's new" file in [`docs/sphinx/source/whatsnew`](https://github.com/pvlib/pvlib-python/tree/main/docs/sphinx/source/whatsnew) for all changes. Includes link to the GitHub Issue with `` :issue:`num` `` or this Pull Request with `` :pull:`num` ``. Includes contributor name and/or GitHub username (link with `` :ghuser:`user` ``).
88
- [ ] New code is fully documented. Includes [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant docstrings, examples, and comments where necessary.
99
- [ ] Pull request is nearly complete and ready for detailed review.
1010
- [ ] Maintainer: Appropriate GitHub Labels (including `remote-data`) and Milestone are assigned to the Pull Request and linked Issue.

.github/workflows/asv_check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: asv
44
on:
55
push:
66
branches:
7-
- master
7+
- main
88
pull_request:
99

1010

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
pull_request:
55
push:
66
branches:
7-
- master
7+
- main
88
tags:
99
- "v*"
1010

.github/workflows/pytest-remote-data.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# A secondary test job that only runs the iotools tests if explicitly requested
2-
# (for pull requests) or on a push to the master branch.
2+
# (for pull requests) or on a push to the main branch.
33
# Because the iotools tests require GitHub secrets, we need to be careful about
44
# malicious PRs accessing the secrets and exposing them externally.
55
#
@@ -48,7 +48,7 @@ on:
4848
types: [labeled]
4949
push:
5050
branches:
51-
- master
51+
- main
5252

5353
jobs:
5454
test:
@@ -68,7 +68,7 @@ jobs:
6868
steps:
6969
- uses: actions/checkout@v3
7070
if: github.event_name == 'pull_request_target'
71-
# pull_request_target runs in the context of the target branch (pvlib/master),
71+
# pull_request_target runs in the context of the target branch (pvlib/main),
7272
# but what we need is the hypothetical merge commit from the PR:
7373
with:
7474
ref: "refs/pull/${{ github.event.number }}/merge"

.github/workflows/pytest.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ on:
44
pull_request:
55
push:
66
branches:
7-
- master
7+
- main
88

99
jobs:
1010
test:

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<tr>
1818
<td>License</td>
1919
<td>
20-
<a href="https://github.com/pvlib/pvlib-python/blob/master/LICENSE">
20+
<a href="https://github.com/pvlib/pvlib-python/blob/main/LICENSE">
2121
<img src="https://img.shields.io/pypi/l/pvlib.svg" alt="license" />
2222
</a>
2323
</td>
@@ -28,11 +28,11 @@
2828
<a href="http://pvlib-python.readthedocs.org/en/stable/">
2929
<img src="https://readthedocs.org/projects/pvlib-python/badge/?version=stable" alt="documentation build status" />
3030
</a>
31-
<a href="https://github.com/pvlib/pvlib-python/actions/workflows/pytest.yml?query=branch%3Amaster">
32-
<img src="https://github.com/pvlib/pvlib-python/actions/workflows/pytest.yml/badge.svg?branch=master" alt="GitHub Actions Testing Status" />
31+
<a href="https://github.com/pvlib/pvlib-python/actions/workflows/pytest.yml?query=branch%3Amain">
32+
<img src="https://github.com/pvlib/pvlib-python/actions/workflows/pytest.yml/badge.svg?branch=main" alt="GitHub Actions Testing Status" />
3333
</a>
3434
<a href="https://codecov.io/gh/pvlib/pvlib-python">
35-
<img src="https://codecov.io/gh/pvlib/pvlib-python/branch/master/graph/badge.svg" alt="codecov coverage" />
35+
<img src="https://codecov.io/gh/pvlib/pvlib-python/branch/main/graph/badge.svg" alt="codecov coverage" />
3636
</a>
3737
</td>
3838
</tr>

benchmarks/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tests are run using
77

88
The basic structure of the tests and how to run them is described below.
99
We refer readers to the ASV documentation for more details. The AstroPy
10-
[documentation](https://github.com/astropy/astropy-benchmarks/tree/master)
10+
[documentation](https://github.com/astropy/astropy-benchmarks/tree/main)
1111
may also be helpful.
1212

1313
The test configuration is described in [asv.conf.json](asv.conf.json).
@@ -23,7 +23,7 @@ For example, if your feature branch is named ``feature``, a useful asv
2323
run may be (from the same directory as `asv.conf.json`):
2424

2525
```
26-
$ asv run master..feature
26+
$ asv run main..feature
2727
```
2828

2929
This will generate timings for every commit between the two specified
@@ -87,7 +87,7 @@ $ asv preview
8787
Nightly benchmarking
8888
--------------------
8989

90-
The benchmarks are run nightly for new commits to pvlib-python/master.
90+
The benchmarks are run nightly for new commits to pvlib-python/main.
9191

9292
- Timing results: https://pvlib-benchmarker.github.io/pvlib-benchmarks/
9393
- Information on the process: https://github.com/pvlib-benchmarker/pvlib-benchmarks

benchmarks/asv.conf.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
// List of branches to benchmark. If not provided, defaults to "master"
3131
// (for git) or "default" (for mercurial).
32-
// "branches": ["master"], // for git
32+
"branches": ["main"], // for git
3333
// "branches": ["default"], // for mercurial
3434

3535
// The DVCS being used. If not set, it will be automatically

docs/sphinx/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ def make_github_url(file_name):
431431
"/docs/sphinx/source/api.rst" or "generated/pvlib.atmosphere.alt2pres.rst"
432432
"""
433433

434-
URL_BASE = "https://github.com/pvlib/pvlib-python/blob/master/"
434+
URL_BASE = "https://github.com/pvlib/pvlib-python/blob/main/"
435435

436436
# is it a gallery page?
437437
if any(d in file_name for d in sphinx_gallery_conf['gallery_dirs']):

docs/sphinx/source/contributing.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ A pull request can also quickly become unmanageable if it proposes
102102
changes to the API in order to implement another feature. Consider
103103
clearly and concisely documenting all proposed API changes before
104104
implementing any code. Modifying
105-
`api.rst <https://github.com/pvlib/pvlib-python/blob/master/docs/sphinx/source/api.rst>`_
106-
and/or the latest `whatsnew file <https://github.com/pvlib/pvlib-python/tree/master/docs/sphinx/source/whatsnew>`_
105+
`api.rst <https://github.com/pvlib/pvlib-python/tree/main/docs/sphinx/source/reference>`_
106+
and/or the latest `whatsnew file <https://github.com/pvlib/pvlib-python/tree/main/docs/sphinx/source/whatsnew>`_
107107
can help formalize this process.
108108

109109
Questions about related issues frequently come up in the process of
@@ -154,7 +154,7 @@ a timely manner is to:
154154
the issue with the appropriate milestone.
155155
#. Make a limited-scope pull request. It can be a lot of work to check all of
156156
the boxes in `pull request guidelines
157-
<https://github.com/pvlib/pvlib-python/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_,
157+
<https://github.com/pvlib/pvlib-python/blob/main/.github/PULL_REQUEST_TEMPLATE.md>`_,
158158
especially for pull requests with a lot of new primary code.
159159
See :ref:`pull-request-scope`.
160160
#. Tag pvlib community members or ``@pvlib`` when the pull
@@ -217,7 +217,7 @@ We typically use GitHub's
217217
"`squash and merge <https://help.github.com/articles/about-pull-request-merges/#squash-and-merge-your-pull-request-commits>`_"
218218
feature to merge your pull request into pvlib. GitHub will condense the
219219
commit history of your branch into a single commit when merging into
220-
pvlib-python/master (the commit history on your branch remains
220+
pvlib-python/main (the commit history on your branch remains
221221
unchanged). Therefore, you are free to make commits that are as big or
222222
small as you'd like while developing your pull request.
223223

@@ -258,7 +258,7 @@ Read the Docs build it for you. Building the docs locally requires installing
258258
pvlib python as an editable library (see :ref:`installation` for instructions).
259259
First, install the ``doc`` dependencies specified in the
260260
``EXTRAS_REQUIRE`` section of
261-
`setup.py <https://github.com/pvlib/pvlib-python/blob/master/setup.py>`_.
261+
`setup.py <https://github.com/pvlib/pvlib-python/blob/main/setup.py>`_.
262262
An easy way to do this is with::
263263

264264
pip install pvlib[doc]
@@ -288,7 +288,7 @@ Example Gallery
288288

289289
The example gallery uses `sphinx-gallery <https://sphinx-gallery.github.io/>`_
290290
and is generated from script files in the
291-
`docs/examples <https://github.com/pvlib/pvlib-python/tree/master/docs/examples>`_
291+
`docs/examples <https://github.com/pvlib/pvlib-python/tree/main/docs/examples>`_
292292
directory. sphinx-gallery will execute example files that start with
293293
``plot_`` and capture the output.
294294

@@ -325,7 +325,7 @@ Testing
325325
Developers **must** include comprehensive tests for any additions or
326326
modifications to pvlib. New unit test code should be placed in the
327327
corresponding test module in the
328-
`pvlib/tests <https://github.com/pvlib/pvlib-python/tree/master/pvlib/tests>`_
328+
`pvlib/tests <https://github.com/pvlib/pvlib-python/tree/main/pvlib/tests>`_
329329
directory.
330330

331331
A pull request will automatically run the tests for you on a variety of
@@ -334,7 +334,7 @@ typically more efficient to run and debug the tests in your own local
334334
environment.
335335

336336
To run the tests locally, install the ``test`` dependencies specified in the
337-
`setup.py <https://github.com/pvlib/pvlib-python/blob/master/setup.py>`_
337+
`setup.py <https://github.com/pvlib/pvlib-python/blob/main/setup.py>`_
338338
file. See :ref:`installation` instructions for more information.
339339

340340
pvlib's unit tests can easily be run by executing ``pytest`` on the
@@ -492,7 +492,7 @@ tests are run using the `airspeed velocity
492492
performance tests for most contributions at this time. Pull request
493493
reviewers will provide further information if a performance test is
494494
necessary. See our `README
495-
<https://github.com/pvlib/pvlib-python/tree/master/benchmarks/README.md>`_
495+
<https://github.com/pvlib/pvlib-python/tree/main/benchmarks/README.md>`_
496496
for instructions on running the benchmarks.
497497

498498

@@ -507,4 +507,4 @@ contributing.html>`_ for inspiration.
507507
Code of Conduct
508508
~~~~~~~~~~~~~~~
509509
All contributors are expected to adhere to the `Contributor Code of Conduct
510-
<https://github.com/pvlib/pvlib-python/blob/master/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct>`_.
510+
<https://github.com/pvlib/pvlib-python/blob/main/CODE_OF_CONDUCT.md#contributor-covenant-code-of-conduct>`_.

docs/sphinx/source/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Please see the :ref:`installation` page for installation help.
1919

2020
For examples of how to use pvlib python, please see
2121
:ref:`package_overview` and our `Jupyter Notebook tutorials
22-
<http://nbviewer.ipython.org/github/pvlib/pvlib-python/tree/master/docs/
22+
<http://nbviewer.ipython.org/github/pvlib/pvlib-python/tree/main/docs/
2323
tutorials/>`_. The documentation assumes general familiarity with
2424
Python, NumPy, and Pandas. Google searches will yield many
2525
excellent tutorials for these packages.
@@ -72,9 +72,9 @@ Additional pvlib python publications include:
7272
* W.F. Holmgren, R.W. Andrews, A.T. Lorenzo, and J.S. Stein,
7373
“PVLIB Python 2015,” in 42nd Photovoltaic Specialists Conference, 2015.
7474
(`paper
75-
<https://github.com/pvlib/pvsc2015/blob/master/pvlib_pvsc_42.pdf>`__ and
75+
<https://github.com/pvlib/pvsc2015/blob/main/pvlib_pvsc_42.pdf>`__ and
7676
the `notebook to reproduce the figures
77-
<http://nbviewer.ipython.org/github/pvlib/pvsc2015/blob/master/paper.ipynb>`_)
77+
<http://nbviewer.ipython.org/github/pvlib/pvsc2015/blob/main/paper.ipynb>`_)
7878
* J.S. Stein, W.F. Holmgren, J. Forbess, and C.W. Hansen,
7979
"PVLIB: Open Source Photovoltaic Performance Modeling Functions
8080
for Matlab and Python," in 43rd Photovoltaic Specialists Conference, 2016.
@@ -85,7 +85,7 @@ Additional pvlib python publications include:
8585
License
8686
=======
8787

88-
`BSD 3-clause <https://github.com/pvlib/pvlib-python/blob/master/LICENSE>`_.
88+
`BSD 3-clause <https://github.com/pvlib/pvlib-python/blob/main/LICENSE>`_.
8989

9090
NumFOCUS
9191
========

docs/sphinx/source/user_guide/forecasts.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ We do not know of a similarly easy way to access archives of forecast data.
4646
This document demonstrates how to use pvlib python to create a PV power
4747
forecast using these tools. The `forecast
4848
<http://nbviewer.jupyter.org/github/pvlib/pvlib-python/blob/
49-
master/docs/tutorials/forecast.ipynb>`_ and `forecast_to_power
49+
main/docs/tutorials/forecast.ipynb>`_ and `forecast_to_power
5050
<http://nbviewer.jupyter.org/github/pvlib/pvlib-python/blob/
51-
master/docs/tutorials/forecast_to_power.ipynb>`_ Jupyter notebooks
51+
main/docs/tutorials/forecast_to_power.ipynb>`_ Jupyter notebooks
5252
provide additional example code.
5353

5454
.. warning::

docs/sphinx/source/user_guide/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ repository <https://github.com/pvlib/pvlib-python>`_ or go to the
9898
download the zip file of the most recent release. You can also use the
9999
nbviewer website to choose a tutorial to experiment with. Go to our
100100
`nbviewer tutorial page
101-
<http://nbviewer.jupyter.org/github/pvlib/pvlib-python/tree/master/docs/
101+
<http://nbviewer.jupyter.org/github/pvlib/pvlib-python/tree/main/docs/
102102
tutorials/>`_.
103103

104104

@@ -228,7 +228,7 @@ pvlib-python is compatible with Python 3.
228228

229229
pvlib-python requires Pandas, Numpy, and SciPy. The minimum version requirements
230230
are specified in
231-
`setup.py <https://github.com/pvlib/pvlib-python/blob/master/setup.py>`_.
231+
`setup.py <https://github.com/pvlib/pvlib-python/blob/main/setup.py>`_.
232232
They are typically releases from several years ago.
233233

234234
A handful of pvlib-python features require additional packages that must

0 commit comments

Comments
 (0)