Skip to content

Commit

Permalink
MNT: Switch 'master' to 'main'
Browse files Browse the repository at this point in the history
  • Loading branch information
dopplershift committed Oct 31, 2024
1 parent 129092c commit 6476c2b
Show file tree
Hide file tree
Showing 13 changed files with 25 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
contact_links:
- name: Questions and Help
url: https://github.com/Unidata/siphon/blob/master/SUPPORT.md#help-using-siphon
url: https://github.com/Unidata/siphon/blob/main/SUPPORT.md#help-using-siphon
about: "If you have a question or need some help, you will likely be better off turning to these resources."
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--
Thanks for contributing a pull request! Please ensure you have taken a look at
the contribution guidelines: https://github.com/Unidata/siphon/blob/master/CONTRIBUTING.md
the contribution guidelines: https://github.com/Unidata/siphon/blob/main/CONTRIBUTING.md
-->

#### Description Of Changes
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/code-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ concurrency:

on:
push:
branches: [master, ]
branches: [main, ]
pull_request:
# The branches below must be a subset of the branches above
branches: [master]
branches: [main]
paths:
- '**.py'
- '.github/codeql/**'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs-conda.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
#
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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]+
Expand Down Expand Up @@ -122,9 +122,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 siphon; print(siphon.__version__.rsplit(".", maxsplit=2)[0])')" >> $GITHUB_ENV

- name: Upload to GitHub Pages
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/linting.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Linting
on:
push:
branches: [master]
branches: [main]
pull_request:

jobs:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/tests-conda.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
#
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/tests-pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
#
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@ Push to your fork and [submit a pull request][pr].
For the Pull Request to be accepted, you need to agree to the
Unidata Contributor License Agreement (CLA). This will be handled automatically
upon submission of a Pull Request.
See [here](https://github.com/Unidata/siphon/blob/master/CLA.md) for more
See [here](https://github.com/Unidata/siphon/blob/main/CLA.md) for more
explanation and rationale behind Unidata's CLA.

As part of the Pull Request, be sure to add yourself to the
[list of contributors](https://github.com/Unidata/Siphon/blob/master/AUTHORS.txt).
[list of contributors](https://github.com/Unidata/Siphon/blob/main/AUTHORS.txt).
We want to make sure we acknowledge the hard work you've generously contributed
here.

Expand Down
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Siphon
:target: https://anaconda.org/conda-forge/siphon
:alt: Conda Package

.. |CodeCov| image:: https://codecov.io/github/Unidata/siphon/coverage.svg?branch=master
:target: https://codecov.io/github/Unidata/siphon?branch=master
.. |CodeCov| image:: https://codecov.io/github/Unidata/siphon/coverage.svg?branch=main
:target: https://codecov.io/github/Unidata/siphon?branch=main
:alt: Code Coverage Status

.. |Codacy| image:: https://api.codacy.com/project/badge/grade/ebacd20b84ab4673bd6cd34f65c48af6
Expand All @@ -41,7 +41,7 @@ Siphon
Siphon is a collection of Python utilities for downloading data from Unidata
data technologies. See our `support page`__ for ways to get help with Siphon.

__ https://github.com/Unidata/siphon/blob/master/SUPPORT.md
__ https://github.com/Unidata/siphon/blob/main/SUPPORT.md

Siphon follows `semantic versioning <https://semver.org>`_ in its version number. With our
current 0.x version, that implies that Siphon's APIs (application programming interfaces) are
Expand Down
5 changes: 1 addition & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,6 @@
# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'Siphon'
copyright = '2018, Siphon Contributors'
Expand Down Expand Up @@ -154,7 +151,7 @@ def setup(app):
html_context = {
'doc_path': 'docs',
'github_repo': 'Unidata/siphon',
'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.
Expand Down
11 changes: 5 additions & 6 deletions docs/developerguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,16 @@ Making Changes
--------------

The changes to the Siphon 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 that
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
branch.
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 commit. 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!

----------
Versioning
Expand Down Expand Up @@ -113,7 +112,7 @@ generated from docstrings, written using the
There are also examples in the ``examples/`` directory.

The documentation is hosted on `GitHub Pages <https://unidata.github.io/siphon>`_. The docs are
built automatically from ``master`` with every build on Travis-CI; every merged PR will
built automatically from ``main`` with every build on Travis-CI; every merged PR will
have the built docs upload to GitHub Pages. As part of the build, the documentation is also
checked with ``doc8``. To see what the docs will look like, you also need to install the
``sphinx-rtd-theme`` package.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ License

Siphon is available under the terms of the open source `BSD 3-Clause license`__.

__ https://raw.githubusercontent.com/Unidata/siphon/master/LICENSE
__ https://raw.githubusercontent.com/Unidata/siphon/main/LICENSE

----------------
Related Projects
Expand Down

0 comments on commit 6476c2b

Please sign in to comment.