Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ commands:
check_changes:
steps:
- run: |
if (test "$CIRCLE_BRANCH" = master ||
git --no-pager diff --name-only origin/master... |
if (test "$CIRCLE_BRANCH" = main ||
git --no-pager diff --name-only origin/main... |
grep -q -E -f .circleci/install_triggers)
then
echo Running installation tests
Expand Down Expand Up @@ -277,7 +277,7 @@ workflows:
filters:
branches:
only:
- master
- main
jobs:
- test
- test_installation
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/action-conda-build.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Conda-build

# runs on a push on master and at the end of every day
# runs on a push on main and at the end of every day
on:
push:
branches:
- master
- main
schedule:
- cron: '0 0 * * *'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/action-conda-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
# use this to test before actual release and publish
push:
branches:
- master
- main

jobs:

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/action-install-from-conda.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Conda Base Install

# runs on a push on master and at the end of every day
# runs on a push on main and at the end of every day
on:
push:
branches:
- master
- main
schedule:
- cron: '0 4 * * *'

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/action-install-from-source.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Source Install

# runs on a push on master and at the end of every day
# runs on a push on main and at the end of every day
on:
push:
branches:
- master
- main
schedule:
- cron: '0 0 * * *'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/action-pypi-build-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
# use this for testing
push:
branches:
- master
- main

jobs:
build-n-publish:
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/action-test-development.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Action that runs the full development stack:
# Steps (Python-only):
# - creates esmvaltool conda environment and pip-installs esmvaltool
# - downloads latest master of esmvalcore and installs it in development mode
# - downloads latest main of esmvalcore and installs it in development mode
# - runs tests of esmvaltool
# Triggered by a push to master and nightly
# Triggered by a push to main and nightly

name: Develop Test

# runs on a push on master and at the end of every day
# runs on a push on main and at the end of every day
on:
push:
branches:
- master
- main
schedule:
- cron: '0 0 * * *'

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/action-test.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Test

# runs on a push on master and at the end of every day
# runs on a push on main and at the end of every day
on:
push:
branches:
- master
- main
schedule:
- cron: '0 0 * * *'

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
[![Documentation Status](https://readthedocs.org/projects/esmvaltool/badge/?version=latest)](https://esmvaltool.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3401363.svg)](https://doi.org/10.5281/zenodo.3401363)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ESMValGroup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![CircleCI](https://circleci.com/gh/ESMValGroup/ESMValTool/tree/master.svg?style=svg)](https://circleci.com/gh/ESMValGroup/ESMValTool/tree/master)
[![example branch parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/ESMValGroup/ESMValTool/actions)
[![CircleCI](https://circleci.com/gh/ESMValGroup/ESMValTool/tree/main.svg?style=svg)](https://circleci.com/gh/ESMValGroup/ESMValTool/tree/main)
[![example branch parameter](https://github.com/github/docs/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/ESMValGroup/ESMValTool/actions)
[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/79bf6932c2e844eea15d0fb1ed7e415c)](https://www.codacy.com/gh/ESMValGroup/ESMValTool?utm_source=github.com&utm_medium=referral&utm_content=ESMValGroup/ESMValTool&utm_campaign=Badge_Coverage)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/79bf6932c2e844eea15d0fb1ed7e415c)](https://www.codacy.com/gh/ESMValGroup/ESMValTool?utm_source=github.com&utm_medium=referral&utm_content=ESMValGroup/ESMValTool&utm_campaign=Badge_Grade)
[![Docker Build Status](https://img.shields.io/docker/cloud/build/esmvalgroup/esmvaltool.svg)](https://hub.docker.com/r/esmvalgroup/esmvaltool/)
[![Anaconda-Server Badge](https://anaconda.org/esmvalgroup/esmvaltool/badges/installer/conda.svg)](https://conda.anaconda.org/esmvalgroup)

![esmvaltoollogo](https://github.com/ESMValGroup/ESMValTool/blob/master/doc/sphinx/source/figures/ESMValTool-logo.png)
![esmvaltoollogo](https://github.com/ESMValGroup/ESMValTool/blob/main/doc/sphinx/source/figures/ESMValTool-logo.png)

- [**Documentation**](https://docs.esmvaltool.org/en/latest/)
- [**ESMValTool Website**](https://www.esmvaltool.org/)
Expand Down
4 changes: 2 additions & 2 deletions doc/sphinx/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Documentation
- Adding tutorial links to documentation (`#1927 <https://github.com/ESMValGroup/ESMValTool/pull/1927>`__) `Birgit Hassler <https://github.com/hb326>`__
- Added bibtex file for schlund20jgr (`#1928 <https://github.com/ESMValGroup/ESMValTool/pull/1928>`__) `Manuel Schlund <https://github.com/schlunma>`__
- Documentation contact added the actual email for the mailing list (`#1938 <https://github.com/ESMValGroup/ESMValTool/pull/1938>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
- Make CircleCI badge specific to master branch (`#1831 <https://github.com/ESMValGroup/ESMValTool/pull/1831>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Make CircleCI badge specific to main branch (`#1831 <https://github.com/ESMValGroup/ESMValTool/pull/1831>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Documentation on how to move code from a private repository to a public repository (`#1920 <https://github.com/ESMValGroup/ESMValTool/pull/1920>`__) `Birgit Hassler <https://github.com/hb326>`__
- Refine pull request review guidelines (`#1924 <https://github.com/ESMValGroup/ESMValTool/pull/1924>`__) `Stef Smeets <https://github.com/stefsmeets>`__
- Update release schedule (`#1948 <https://github.com/ESMValGroup/ESMValTool/pull/1948>`__) `Klaus Zimmermann <https://github.com/zklaus>`__
Expand Down Expand Up @@ -104,7 +104,7 @@ Automatic testing
- Fix conda installation test on CircleCI (`#1952 <https://github.com/ESMValGroup/ESMValTool/pull/1952>`__) `Bouwe Andela <https://github.com/bouweandela>`__
- Github Actions: change time for cron job that installs from conda (`#1969 <https://github.com/ESMValGroup/ESMValTool/pull/1969>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
- CI upload relevant artifacts for test job (`#1999 <https://github.com/ESMValGroup/ESMValTool/pull/1999>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
- Github Actions test that runs with the latest ESMValCore master (`#1989 <https://github.com/ESMValGroup/ESMValTool/pull/1989>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
- Github Actions test that runs with the latest ESMValCore main (`#1989 <https://github.com/ESMValGroup/ESMValTool/pull/1989>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
- Introduce python 39 in Github Actions tests (`#2029 <https://github.com/ESMValGroup/ESMValTool/pull/2029>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
- Remove test for conda package installation on Python 3.6 (`#2033 <https://github.com/ESMValGroup/ESMValTool/pull/2033>`__) `Valeriu Predoi <https://github.com/valeriupredoi>`__
- Update codacy coverage reporter to fix coverage (`#2039 <https://github.com/ESMValGroup/ESMValTool/pull/2039>`__) `Bouwe Andela <https://github.com/bouweandela>`__
Expand Down
30 changes: 15 additions & 15 deletions doc/sphinx/source/community/code_documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ New development should preferably be done in the
GitHub repository.
However, for scientists requiring confidentiality, private repositories are
available, see :ref:`private_repository` for more information.
The default git branch is ``master``. Use
The default git branch is ``main``. Use
this branch to create a new feature branch from and make a pull request
against.
This
Expand Down Expand Up @@ -263,9 +263,9 @@ and is built using `Sphinx <https://www.sphinx-doc.org>`_.
There are two main ways of adding documentation:

#. As written text in the directory
`doc/sphinx/source <https://github.com/ESMValGroup/ESMValTool/tree/master/doc/sphinx/source>`__.
`doc/sphinx/source <https://github.com/ESMValGroup/ESMValTool/tree/main/doc/sphinx/source>`__.
When writing
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
`reStructuredText <https://www.sphinx-doc.org/en/main/usage/restructuredtext/basics.html>`_
(``.rst``) files, please try to limit the line length to 80 characters and
always start a sentence on a new line.
This makes it easier to review changes to documentation on GitHub.
Expand All @@ -275,7 +275,7 @@ There are two main ways of adding documentation:
`docstrings <https://www.python.org/dev/peps/pep-0257/>`__
of Python modules, classes, and functions
that are mentioned in
`doc/sphinx/source/api <https://github.com/ESMValGroup/ESMValTool/tree/master/doc/sphinx/source/api>`__
`doc/sphinx/source/api <https://github.com/ESMValGroup/ESMValTool/tree/main/doc/sphinx/source/api>`__
are used to generate documentation.
This results in the :ref:`api`.

Expand Down Expand Up @@ -332,7 +332,7 @@ CircleCI_ will build the documentation with the command
to catch mistakes that can be detected automatically.

The configuration file for Sphinx_ is
`doc/shinx/source/conf.py <https://github.com/ESMValGroup/ESMValTool/blob/master/doc/sphinx/source/conf.py>`_.
`doc/shinx/source/conf.py <https://github.com/ESMValGroup/ESMValTool/blob/main/doc/sphinx/source/conf.py>`_.

When reviewing a pull request, always check that the documentation checks
shown below the pull request were successful.
Expand All @@ -355,9 +355,9 @@ For example, ``:ref:`esmvalcore:recipe``` to link to
There is a script that generates the navigation menu shown on the left when
you view the documentation.
This script is called
`doc/sphinx/source/gensidebar.py <https://github.com/ESMValGroup/ESMValTool/blob/master/doc/sphinx/source/gensidebar.py>`_
`doc/sphinx/source/gensidebar.py <https://github.com/ESMValGroup/ESMValTool/blob/main/doc/sphinx/source/gensidebar.py>`_
in the ESMValTool repository and it should be identical to
`doc/gensidebar.py <https://github.com/ESMValGroup/ESMValCore/blob/master/doc/gensidebar.py>`_
`doc/gensidebar.py <https://github.com/ESMValGroup/ESMValCore/blob/main/doc/gensidebar.py>`_
in the ESMValCore repository, or the sidebar will change when navigating from
the ESMValTool documentation to the ESMValCore documentation and vice-versa.

Expand All @@ -367,7 +367,7 @@ Tests
-----

To check various aspects of the recipes and code, there tests available in the
`tests <https://github.com/ESMValGroup/ESMValTool/tree/master/tests>`__
`tests <https://github.com/ESMValGroup/ESMValTool/tree/main/tests>`__
directory.

Whenever you make a pull request or push new commits to an existing pull
Expand All @@ -389,16 +389,16 @@ These nightly tests have been designed to mimic the installation procedures
described in the documentation, e.g. in the :ref:`install` chapter.
The nightly tests are run using both CircleCI and GitHub Actions, the
result of the tests ran by CircleCI can be seen on the
`CircleCI project page <https://app.circleci.com/pipelines/github/ESMValGroup/ESMValTool?branch=master>`__
`CircleCI project page <https://app.circleci.com/pipelines/github/ESMValGroup/ESMValTool?branch=main>`__
and the result of the tests ran by GitHub Actions can be viewed on the
`Actions tab <https://github.com/ESMValGroup/ESMValTool/actions>`__
of the repository.

The configuration of the tests run by CircleCI can be found in the directory
`.circleci <https://github.com/ESMValGroup/ESMValTool/blob/master/.circleci>`__,
`.circleci <https://github.com/ESMValGroup/ESMValTool/blob/main/.circleci>`__,
while the configuration of the tests run by GitHub Actions can be found in the
directory
`.github/workflows <https://github.com/ESMValGroup/ESMValTool/blob/master/.github/workflows>`__.
`.github/workflows <https://github.com/ESMValGroup/ESMValTool/blob/main/.github/workflows>`__.

When reviewing a pull request, always check that all test jobs on CircleCI_ were
successful.
Expand All @@ -420,7 +420,7 @@ name to the list of authors in ``CITATION.cff`` and generate the entry for the
cffconvert --ignore-suspect-keys --outputformat zenodo --outfile .zenodo.json

Note that authors of recipes and/or diagnostics also need to be added to the file
`esmvaltool/config-references.yml <https://github.com/ESMValGroup/ESMValTool/blob/master/esmvaltool/config-references.yml>`__,
`esmvaltool/config-references.yml <https://github.com/ESMValGroup/ESMValTool/blob/main/esmvaltool/config-references.yml>`__,
see :ref:`recording-provenance` for more information.

.. _dependencies:
Expand All @@ -433,7 +433,7 @@ Before considering adding a new dependency, carefully check that the
of the dependency you want to add and any of its dependencies are
`compatible <https://the-turing-way.netlify.app/reproducible-research/licensing/licensing-compatibility.html>`__
with the
`Apache 2.0 <https://github.com/ESMValGroup/ESMValTool/blob/master/LICENSE/>`_
`Apache 2.0 <https://github.com/ESMValGroup/ESMValTool/blob/main/LICENSE/>`_
license that applies to the ESMValTool.
Note that GPL version 2 license is considered incompatible with the Apache 2.0
license, while the compatibility of GPL version 3 license with the Apache 2.0
Expand Down Expand Up @@ -500,8 +500,8 @@ You can attract the attention of the `@ESMValGroup/esmvaltool-coreteam`_ by
mentioning them in the issue if it looks like no-one is working on solving the
problem yet.
The issue needs to be fixed in a separate pull request first.
After that has been merged into the ``master`` branch and all checks are green
again on the ``master`` branch, merge it into your own branch to get the tests
After that has been merged into the ``main`` branch and all checks are green
again on the ``main`` branch, merge it into your own branch to get the tests
to pass.

When reviewing a pull request, always make sure that all checks were successful.
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/source/community/dataset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Testing
=======

When contributing a new script, add an entry for the CMORized data to
`recipes/examples/recipe_check_obs.yml <https://github.com/ESMValGroup/ESMValTool/blob/master/esmvaltool/recipes/examples/recipe_check_obs.yml>`__
`recipes/examples/recipe_check_obs.yml <https://github.com/ESMValGroup/ESMValTool/blob/main/esmvaltool/recipes/examples/recipe_check_obs.yml>`__
and run the recipe, to make sure the CMOR checks pass without warnings or errors.

To test a pull request for a new CMORizer script:
Expand Down
Loading