Skip to content
This repository was archived by the owner on Jan 27, 2024. It is now read-only.

Commit 6b12387

Browse files
pllimbsipocz
andcommitted
MNT: Replace master with main
Revert out-of-scope changes. Replace some words in narrative. Apply suggestions from bsipocz DOC: Remove mentioned of astropy-notebooks Co-authored-by: Brigitta Sipőcz <[email protected]>
1 parent 0cb6141 commit 6b12387

39 files changed

+148
-163
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ about: Create a report describing unexpected or incorrect behavior in astropy.
77
so you do not need to remove them! -->
88

99
<!-- Please be sure to check out our contributing guidelines,
10-
https://github.com/astropy/astropy/blob/master/CONTRIBUTING.md .
10+
https://github.com/astropy/astropy/blob/main/CONTRIBUTING.md .
1111
Please be sure to check out our code of conduct,
12-
https://github.com/astropy/astropy/blob/master/CODE_OF_CONDUCT.md . -->
12+
https://github.com/astropy/astropy/blob/main/CODE_OF_CONDUCT.md . -->
1313

1414
<!-- Please have a search on our GitHub repository to see if a similar
1515
issue has already been posted.

.github/ISSUE_TEMPLATE/feature_request.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ about: Suggest an idea to improve astropy
77
so you do not need to remove them! -->
88

99
<!-- Please be sure to check out our contributing guidelines,
10-
https://github.com/astropy/astropy/blob/master/CONTRIBUTING.md .
10+
https://github.com/astropy/astropy/blob/main/CONTRIBUTING.md .
1111
Please be sure to check out our code of conduct,
12-
https://github.com/astropy/astropy/blob/master/CODE_OF_CONDUCT.md . -->
12+
https://github.com/astropy/astropy/blob/main/CODE_OF_CONDUCT.md . -->
1313

1414
<!-- Please have a search on our GitHub repository to see if a similar
1515
issue has already been posted.

.github/PULL_REQUEST_TEMPLATE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
so you do not need to remove them! -->
33

44
<!-- Please be sure to check out our contributing guidelines,
5-
https://github.com/astropy/astropy/blob/master/CONTRIBUTING.md .
5+
https://github.com/astropy/astropy/blob/main/CONTRIBUTING.md .
66
Please be sure to check out our code of conduct,
7-
https://github.com/astropy/astropy/blob/master/CODE_OF_CONDUCT.md . -->
7+
https://github.com/astropy/astropy/blob/main/CODE_OF_CONDUCT.md . -->
88

99
<!-- If you are new or need to be re-acquainted with Astropy
1010
contributing workflow, please see

.github/workflows/ci_workflows.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: CI
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77
tags:
88
- '*'
99
pull_request:

.github/workflows/open_actions.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
2828
A project member will respond to you as soon as possible; in
2929
the meantime, please double-check the [guidelines for submitting
30-
issues](https://github.com/astropy/astropy/blob/master/CONTRIBUTING.md#reporting-issues)
30+
issues](https://github.com/astropy/astropy/blob/main/CONTRIBUTING.md#reporting-issues)
3131
and make sure you've provided the requested details.
3232
3333
@@ -45,7 +45,7 @@ jobs:
4545
4646
A project member will respond to you as soon as possible; in the
4747
meantime, please have a look over the [Checklist for Contributed
48-
Code](https://github.com/astropy/astropy/blob/master/CONTRIBUTING.md#checklist-for-contributed-code)
48+
Code](https://github.com/astropy/astropy/blob/main/CONTRIBUTING.md#checklist-for-contributed-code)
4949
and make sure you've addressed as many of the questions there as
5050
possible.
5151

CITATION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
See https://github.com/astropy/astropy/blob/master/astropy/CITATION
1+
See https://github.com/astropy/astropy/blob/main/astropy/CITATION

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ and follow the Astropy guidelines for reuse, interoperability, and interfacing.
5656
Each affiliated package has its own developers/maintainers and its own specific
5757
guidelines for contributions, so be sure to read their docs.
5858

59-
Once you open a pull request (which should be opened against the ``master``
59+
Once you open a pull request (which should be opened against the ``main``
6060
branch, not against any of the other branches), please make sure to
6161
include the following:
6262

README.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ Astropy is licensed under a 3-clause BSD style license - see the
5252
:target: https://github.com/astropy/astropy/actions
5353
:alt: Astropy's GitHub Actions CI Status
5454

55-
.. |CircleCI Status| image:: https://img.shields.io/circleci/build/github/astropy/astropy/master?logo=circleci&label=CircleCI
55+
.. |CircleCI Status| image:: https://img.shields.io/circleci/build/github/astropy/astropy/main?logo=circleci&label=CircleCI
5656
:target: https://circleci.com/gh/astropy/astropy
5757
:alt: Astropy's CircleCI Status
5858

59-
.. |Azure Status| image:: https://dev.azure.com/astropy-project/astropy/_apis/build/status/astropy.astropy?repoName=astropy%2Fastropy&branchName=master
59+
.. |Azure Status| image:: https://dev.azure.com/astropy-project/astropy/_apis/build/status/astropy.astropy?repoName=astropy%2Fastropy&branchName=main
6060
:target: https://dev.azure.com/astropy-project/astropy
6161
:alt: Astropy's Azure Pipelines Status
6262

63-
.. |Coverage Status| image:: https://codecov.io/gh/astropy/astropy/branch/master/graph/badge.svg
63+
.. |Coverage Status| image:: https://codecov.io/gh/astropy/astropy/branch/main/graph/badge.svg
6464
:target: https://codecov.io/gh/astropy/astropy
6565
:alt: Astropy's Coverage Status
6666

astropy/config/configuration.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ def _validate_val(self, val):
483483
return self._validator.check(self.cfgtype, val)
484484

485485

486-
# this dictionary stores the master copy of the ConfigObj's for each
486+
# this dictionary stores the primary copy of the ConfigObj's for each
487487
# root package
488488
_cfgobjs = {}
489489

astropy/config/tests/data/astropy.0.3.cfg

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ conesearch_dbname = conesearch_good
139139

140140
[vo.validator.validate]
141141

142-
# Cone Search services master list for validation.
142+
# Cone Search services default list for validation.
143143
cs_mstr_list = http://vao.stsci.edu/directory/NVORegInt.asmx/VOTCapabilityPredOpt?predicate=1%3D1&capability=conesearch&VOTStyleOption=2
144144

145145
# Only check these Cone Search URLs.

astropy/config/tests/data/astropy.0.3.windows.cfg

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ conesearch_dbname = conesearch_good
139139

140140
[vo.validator.validate]
141141

142-
# Cone Search services master list for validation.
142+
# Cone Search services default list for validation.
143143
cs_mstr_list = http://vao.stsci.edu/directory/NVORegInt.asmx/VOTCapabilityPredOpt?predicate=1%3D1&capability=conesearch&VOTStyleOption=2
144144

145145
# Only check these Cone Search URLs.

astropy/coordinates/sky_coordinate.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,7 @@ def _is_name(self, string):
760760
def __getattr__(self, attr):
761761
"""
762762
Overrides getattr to return coordinates that this can be transformed
763-
to, based on the alias attr in the master transform graph.
763+
to, based on the alias attr in the primary transform graph.
764764
"""
765765
if '_sky_coord_frame' in self.__dict__:
766766
if self._is_name(attr):

astropy/coordinates/tests/test_representation.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1360,7 +1360,7 @@ def test_represent_as(self):
13601360
for name in REPRESENTATION_CLASSES:
13611361
if name == 'radial':
13621362
# TODO: Converting a CartesianDifferential to a
1363-
# RadialDifferential fails, even on `master`
1363+
# RadialDifferential fails, even on `main`
13641364
continue
13651365
elif name.endswith("geodetic"):
13661366
# TODO: Geodetic representations do not have differentials yet

astropy/io/ascii/ecsv.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ class Ecsv(basic.Basic):
241241
Th ECSV format allows for specification of key table and column meta-data, in
242242
particular the data type and unit.
243243
244-
See: https://github.com/astropy/astropy-APEs/blob/master/APE6.rst
244+
See: https://github.com/astropy/astropy-APEs/blob/main/APE6.rst
245245
246246
Examples
247247
--------

azure-pipelines.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ resources:
1010
name: OpenAstronomy/azure-pipelines-templates
1111
ref: master
1212

13-
# NOTE: for now we only use Azure Pipelines on v* branches, tags, and master
13+
# NOTE: for now we only use Azure Pipelines on v* branches, tags, and main
1414
# only on a cron for building the source and wheel distributions. If you want to
1515
# make changes to this configuration via a pull request, you can *temporarily*
1616
# change the pr branches include trigger to just '*'
1717
trigger:
1818
branches:
1919
include:
2020
- 'v*'
21-
- master
21+
- main
2222
tags:
2323
include:
2424
- 'v*'
@@ -32,7 +32,7 @@ schedules:
3232
displayName: Daily Build for Nightly Wheels
3333
branches:
3434
include:
35-
- master
35+
- main
3636
always: true
3737

3838
# Build Linux wheels using manylinux1 for compatibility with old versions
@@ -43,8 +43,8 @@ variables:
4343
CI: true
4444

4545
jobs:
46-
# Run this job on non-master branches (when triggered) or if we are on master and on the cron, or if manually triggered through the web ui.
47-
- ${{ if or(ne(variables['Build.SourceBranchName'], 'master'), eq(variables['Build.Reason'], 'Schedule'), eq(variables['Build.Reason'], 'Manual')) }}:
46+
# Run this job on non-main branches (when triggered) or if we are on main and on the cron, or if manually triggered through the web ui.
47+
- ${{ if or(ne(variables['Build.SourceBranchName'], 'main'), eq(variables['Build.Reason'], 'Schedule'), eq(variables['Build.Reason'], 'Manual')) }}:
4848
- template: publish.yml@OpenAstronomy
4949
parameters:
5050

@@ -59,8 +59,8 @@ jobs:
5959
${{ if startsWith(variables['Build.SourceBranch'], 'refs/tags/v') }}:
6060
pypi_connection_name : 'pypi_endpoint'
6161

62-
# If the build has run on master then upload the artifacts to the nightly feed
63-
${{ if eq(variables['Build.SourceBranchName'], 'master') }}:
62+
# If the build has run on main then upload the artifacts to the nightly feed
63+
${{ if eq(variables['Build.SourceBranchName'], 'main') }}:
6464
artifact_project : 'astropy'
6565
artifact_feed : 'nightly'
6666
remove_local_scheme: true

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ def minvers(name):
222222

223223
# Setting this URL is requited by sphinx-astropy
224224
github_issues_url = 'https://github.com/astropy/astropy/issues/'
225-
edit_on_github_branch = 'master'
225+
edit_on_github_branch = 'main'
226226

227227
# Enable nitpicky mode - which ensures that all references in the docs
228228
# resolve.

docs/coordinates/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ Overview of `astropy.coordinates` Concepts
416416
.. note ::
417417
The `~astropy.coordinates` package from v0.4 onward builds from
418418
previous versions of the package, and more detailed information and
419-
justification of the design is available in `APE (Astropy Proposal for Enhancement) 5 <https://github.com/astropy/astropy- APEs/blob/master/APE5.rst>`_.
419+
justification of the design is available in `APE (Astropy Proposal for Enhancement) 5 <https://github.com/astropy/astropy-APEs/blob/main/APE5.rst>`_.
420420
421421
Here we provide an overview of the package and associated framework.
422422
This background information is not necessary for using `~astropy.coordinates`,

docs/credits.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ Other Credits
421421

422422
(If you have contributed to the ``astropy`` core package and your name is missing,
423423
please send an email to the coordinators, or
424-
`open a pull request for this page <https://github.com/astropy/astropy/edit/master/docs/credits.rst>`_
424+
`open a pull request for this page <https://github.com/astropy/astropy/edit/main/docs/credits.rst>`_
425425
in the `astropy repository <https://github.com/astropy/astropy>`_)
426426

427427
For how to acknowledge Astropy, please see `the Acknowledging or Citing Astropy page <https://www.astropy.org/acknowledging.html>`_.

docs/development/astropy-package-template.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,10 @@ by ``CHANGES.md`` in the instructions.
138138
instructions. Check that the entry on PyPI is correct, and that
139139
the tarfile is present.
140140

141-
#. Go back to the master branch and push your changes to github::
141+
#. Go back to the main branch and push your changes to github::
142142

143-
git checkout master
144-
git push --tags origin master
143+
git checkout main
144+
git push --tags origin main
145145

146146
Once you have done this, if you use Read the Docs, trigger a ``latest`` build
147147
then go to the project settings, and under **Versions** you should see the

docs/development/codeguide.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Interface and Dependencies
1414

1515
* All code must be compatible with the versions of Python indicated by the
1616
``python_requires`` key in the `setup.cfg
17-
<https://github.com/astropy/astropy/blob/master/setup.cfg>`_ file of the
17+
<https://github.com/astropy/astropy/blob/main/setup.cfg>`_ file of the
1818
core package.
1919

2020
* Usage of ``six``, ``__future__``, and ``2to3`` is no longer acceptable.

docs/development/releasing.rst

+23-23
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Post-Release procedures
189189
list on the web site if you updated the ``docs/credits.rst`` at the outset.
190190

191191
#. Cherry-pick the commit rendering the changelog and deleting the fragments and
192-
open a PR to the astropy *master* branch. Note: updating this when doing the
192+
open a PR to the astropy *main* branch. Note: updating this when doing the
193193
next release with towncrier.
194194
In the same PR, you also have to update ``docs/whatsnew/index.rst`` and
195195
``docs/whatsnew/X.Y.rst`` to link to "what's new" documentation in the
@@ -265,21 +265,21 @@ Performing a Feature Freeze/Branching new Major Versions
265265
========================================================
266266

267267
As outlined in
268-
`APE2 <https://github.com/astropy/astropy-APEs/blob/master/APE2.rst>`_, astropy
268+
`APE2 <https://github.com/astropy/astropy-APEs/blob/main/APE2.rst>`_, astropy
269269
releases occur at regular intervals, but feature freezes occur well before the
270-
actual release. Feature freezes are also the time when the master branch's
270+
actual release. Feature freezes are also the time when the main branch's
271271
development separates from the new major version's maintenance branch. This
272272
allows new development for the next major version to continue while the
273273
soon-to-be-released version can focus on bug fixes and documentation updates.
274274

275275
The procedure for this is straightforward:
276276

277-
#. Update your local master branch to use to the latest version from github::
277+
#. Update your local main branch to use to the latest version from github::
278278

279279
$ git fetch upstream --tags
280-
$ git checkout -B master upstream/master
280+
$ git checkout -B main upstream/main
281281

282-
#. Create a new branch from master at the point you want the feature freeze to
282+
#. Create a new branch from main at the point you want the feature freeze to
283283
occur::
284284

285285
$ git branch v<version>.x
@@ -312,7 +312,7 @@ The procedure for this is straightforward:
312312
#. Push all of these changes up to github::
313313

314314
$ git push upstream v<version>.x:v<version>.x
315-
$ git push upstream master:master
315+
$ git push upstream main:main
316316

317317
.. note::
318318

@@ -343,17 +343,17 @@ that enhance clarity but do not describe new features (e.g., more examples,
343343
typo fixes, etc).
344344

345345
Bug fix releases are typically managed by maintaining one or more bug fix
346-
branches separate from the master branch (the release procedure below discusses
346+
branches separate from the main branch (the release procedure below discusses
347347
creating these branches). Typically, whenever an issue is fixed on the Astropy
348-
master branch a decision must be made whether this is a fix that should be
348+
main branch a decision must be made whether this is a fix that should be
349349
included in the Astropy bug fix release. Usually the answer to this question
350350
is "yes", though there are some issues that may not apply to the bug fix
351351
branch. For example, it is not necessary to backport a fix to a new feature
352352
that did not exist when the bug fix branch was first created. New features
353353
are never merged into the bug fix branch--only bug fixes; hence the name.
354354

355355
In rare cases a bug fix may be made directly into the bug fix branch without
356-
going into the master branch first. This may occur if a fix is made to a
356+
going into the main branch first. This may occur if a fix is made to a
357357
feature that has been removed or rewritten in the development version and no
358358
longer has the issue being fixed. However, depending on how critical the bug
359359
is it may be worth including in a bug fix release, as some users can be slow to
@@ -366,31 +366,31 @@ For example, at the time of writing there are two release milestones open:
366366
v1.2.2 and v0.3.0. In this case, v1.2.2 is the next bug fix release and all
367367
issues that should include fixes in that release should be assigned that
368368
milestone. Any issues that implement new features would go into the v0.3.0
369-
milestone--this is any work that goes in the master branch that should not
369+
milestone--this is any work that goes in the main branch that should not
370370
be backported. For a more detailed set of guidelines on using milestones, see
371371
:ref:`milestones-and-labels`.
372372

373373

374374
.. _release-procedure-bug-fix-backport:
375375

376-
Backporting fixes from master
377-
-----------------------------
376+
Backporting fixes from main
377+
---------------------------
378378

379379
.. note::
380380

381381
The changelog script in ``astropy-procedures`` (``pr_consistency`` scripts
382382
in particular) does not know about minor releases, thus please be careful.
383-
For example, let's say we have two branches (``master`` and ``v1.2.x``).
383+
For example, let's say we have two branches (``main`` and ``v1.2.x``).
384384
Both 1.2.0 and 1.2.1 releases will come out of the same v1.2.x branch.
385-
If a PR for 1.2.1 is merged into ``master`` before 1.2.0 is released,
385+
If a PR for 1.2.1 is merged into ``main`` before 1.2.0 is released,
386386
it should not be backported into v1.2.x branch until after 1.2.0 is
387387
released, despite complaining from the aforementioned script.
388388
This situation only arises in a very narrow time frame after 1.2.0
389389
freeze but before its release.
390390

391391
Most fixes are backported using the ``git cherry-pick`` command, which applies
392392
the diff from a single commit like a patch. For the sake of example, say the
393-
current bug fix branch is 'v1.2.x', and that a bug was fixed in master in a
393+
current bug fix branch is 'v1.2.x', and that a bug was fixed in main in a
394394
commit ``abcd1234``. In order to backport the fix, checkout the v1.2.x
395395
branch (it's also good to make sure it's in sync with the
396396
`astropy core repository`_) and cherry-pick the appropriate commit::
@@ -408,8 +408,8 @@ sure to backport that as well.
408408

409409
What if the issue required more than one commit to fix? There are a few
410410
possibilities for this. The easiest is if the fix came in the form of a
411-
pull request that was merged into the master branch. Whenever GitHub merges
412-
a pull request it generates a merge commit in the master branch. This merge
411+
pull request that was merged into the main branch. Whenever GitHub merges
412+
a pull request it generates a merge commit in the main branch. This merge
413413
commit represents the *full* difference of all the commits in the pull request
414414
combined. What this means is that it is only necessary to cherry-pick the
415415
merge commit (this requires adding the ``-m 1`` option to the cherry-pick
@@ -457,11 +457,11 @@ there are two choices:
457457
check out the bug fix branch and commit and push your fix directly.
458458

459459
2. **Preferable**: You may also make a pull request through GitHub against the
460-
bug fix branch rather than against master. Normally when making a pull
460+
bug fix branch rather than against main. Normally when making a pull
461461
request from a branch on your fork to the `astropy core repository`_, GitHub
462-
compares your branch to Astropy's master. If you look on the left-hand
462+
compares your branch to Astropy's main. If you look on the left-hand
463463
side of the pull request page, under "base repo: astropy/astropy" there is
464-
a drop-down list labeled "base branch: master". You can click on this
464+
a drop-down list labeled "base branch: main". You can click on this
465465
drop-down and instead select the bug fix branch ("v1.2.x" for example). Then
466466
GitHub will instead compare your fix against that branch, and merge into
467467
that branch when the PR is accepted.
@@ -483,7 +483,7 @@ right version number).
483483

484484
2. The Astropy changelog must be updated to list all issues--especially
485485
user-visible issues--fixed for the current release. The changelog should
486-
be updated in the master branch, and then merged into the bug fix branch.
486+
be updated in the main branch, and then merged into the bug fix branch.
487487
Most issues *should* already have changelog entries for them. But
488488
occasionally these are forgotten, so if doesn't exist yet please add one in
489489
the process of backporting. See :ref:`changelog-format` for more details.
@@ -504,7 +504,7 @@ The script to actually check consistency should be run like::
504504
$ python 4.check_consistency.py > consistency.html
505505

506506
Which will generate a simple web page that shows all of the areas where either
507-
a pull request was merged into master but is *not* in the relevant release that
507+
a pull request was merged into main but is *not* in the relevant release that
508508
it has been milestoned for, as well as any changelog irregularities (i.e., PRs
509509
that are in the wrong section for what the github milestone indicates). You'll
510510
want to correct those irregularities *first* before starting the backport

0 commit comments

Comments
 (0)