Skip to content

Commit

Permalink
Merge pull request #297 from raybellwaves/master-to-main
Browse files Browse the repository at this point in the history
  • Loading branch information
raybellwaves committed Apr 25, 2021
2 parents 2217b58 + 0ad56b5 commit 96d3dc7
Show file tree
Hide file tree
Showing 7 changed files with 178 additions and 184 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Please describe the tests that you ran to verify your changes. This could point

## Pre-Merge Checklist (final steps)

- [ ] I have rebased onto master or develop (wherever I am merging) and dealt with any conflicts.
- [ ] I have rebased onto main or develop (wherever I am merging) and dealt with any conflicts.
- [ ] I have squashed commits to a reasonable amount, and force-pushed the squashed commits.

## References
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/upstream-dev-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ name: CI Upstream
on:
push:
branches:
- master
- main
pull_request:
branches:
- master
- main
schedule:
- cron: "0 0 * * 4" # Thursdays At 00:00 UTC
- cron: "0 0 * * 4" # Thursdays At 00:00 UTC
workflow_dispatch: # allows you to trigger the workflow run manually

jobs:
Expand Down
14 changes: 7 additions & 7 deletions HOWTOCONTRIBUTE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,9 @@ Preparing Pull Requests
$ cd xskillscore
$ git remote add upstream git@github.com:xarray-contrib/xskillscore.git

# now, to fix a bug or add feature create your own branch off "master":
# now, to fix a bug or add feature create your own branch off "main":

$ git checkout -b your-bugfix-feature-branch-name master
$ git checkout -b your-bugfix-feature-branch-name main

If you need some help with Git, follow this quick start
guide: https://git.wiki.kernel.org/index.php/QuickStart
Expand Down Expand Up @@ -162,7 +162,7 @@ These benchmarks are all found in the ``asv_bench`` directory.

If you need to run a benchmark, change your directory to ``asv_bench/`` and run::

$ asv continuous -f 1.1 upstream/master HEAD
$ asv continuous -f 1.1 upstream/main HEAD

You can replace ``HEAD`` with the name of the branch you are working on,
and report benchmarks that changed by more than 10%.
Expand All @@ -176,12 +176,12 @@ regressions. You can run specific benchmarks using the ``-b`` flag, which
takes a regular expression. For example, this will only run tests from a
``asv_bench/benchmarks/deterministic.py`` file::

$ asv continuous -f 1.1 upstream/master HEAD -b ^deterministic
$ asv continuous -f 1.1 upstream/main HEAD -b ^deterministic

If you want to only run a specific group of tests from a file, you can do it
using ``.`` as a separator. For example::

$ asv continuous -f 1.1 upstream/master HEAD -b deterministic.Compute_small.time_xskillscore_metric_small
$ asv continuous -f 1.1 upstream/main HEAD -b deterministic.Compute_small.time_xskillscore_metric_small

will only run the ``time_xskillscore_metric_small`` benchmark of class ``Compute_small``
defined in ``deterministic.py``.
Expand All @@ -206,8 +206,8 @@ defined in ``deterministic.py``.
head-fork: YOUR_GITHUB_USERNAME/xskillscore
compare: your-branch-name

base-fork: raybellwaves/xskillscore
base: master
base-fork: xarray-contrib/xskillscore
base: main

Note that you can create the Pull Request while you're working on this. The PR will update
as you add more commits. ``xskillscore`` developers and contributors can then review your code
Expand Down
10 changes: 5 additions & 5 deletions HOWTORELEASE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ Release Procedure
* Update ``CHANGELOG.rst``
* Make sure all new changes, features are reflected in the documentation.

#. Open a new pull request for this branch targeting `master`
#. Open a new pull request for this branch targeting `main`

#. After all tests pass and the PR has been approved, merge the PR into ``master``
#. After all tests pass and the PR has been approved, merge the PR into ``main``

#. Tag a release and push to github::

$ git tag -a v0.0.xx -m "Version 0.0.xx"
$ git push origin master --tags
$ git push origin main --tags

#. Build and publish release on PyPI::

Expand All @@ -26,9 +26,9 @@ Release Procedure
#. Update the stable branch (used by ReadTheDocs)::

$ git checkout stable
$ git rebase master
$ git rebase main
$ git push -f origin stable
$ git checkout master
$ git checkout main

#. Go to https://readthedocs.org and add the new version to "Active Versions"
under the version tab. Force-build "stable" if it isn't already building.
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ xskillscore: Metrics for verifying forecasts
.. image:: https://anaconda.org/conda-forge/xskillscore/badges/version.svg
:target: https://anaconda.org/conda-forge/xskillscore/

.. image:: https://codecov.io/gh/xarray-contrib/xskillscore/branch/master/graph/badge.svg
.. image:: https://codecov.io/gh/xarray-contrib/xskillscore/branch/main/graph/badge.svg
:target: https://codecov.io/gh/xarray-contrib/xskillscore

.. image:: https://img.shields.io/readthedocs/xskillscore/stable.svg?style=flat
Expand Down
Loading

0 comments on commit 96d3dc7

Please sign in to comment.