Skip to content

Commit 6199097

Browse files
authored
MAINT: default branch got renamed (#711)
* CI: default branch got renamed * Changing default branch for docs build * Changing default branch in docs
1 parent a0d0275 commit 6199097

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: continuous-integration
22

33
on:
44
push:
5-
branches: [master]
5+
branches: [main]
66
tags:
77
- 'v*'
88
pull_request:

.github/workflows/tests_devdeps.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: continuous-integration-devdeps
22

33
on:
44
push:
5-
branches: [master]
5+
branches: [main]
66
schedule:
77
# run every Monday at 5am UTC
88
- cron: '0 5 * * 1'

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
html_theme_options = {
117117
"github_url": "https://github.com/executablebooks/myst-nb",
118118
"repository_url": "https://github.com/executablebooks/myst-nb",
119-
"repository_branch": "master",
119+
"repository_branch": "main",
120120
"home_page_in_toc": True,
121121
"path_to_docs": "docs",
122122
"show_navbar_depth": 1,

docs/reference/contributing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To install `MyST-NB` for package development (you will need a recent version of
1515
```bash
1616
git clone https://github.com/executablebooks/MyST-NB
1717
cd MyST-NB
18-
git checkout master
18+
git checkout main
1919
pip install -e .[code_style,testing,rtd]
2020
```
2121

@@ -116,21 +116,21 @@ pytest -v --cov=myst_nb --cov-report=html
116116

117117
### Test File and Directory Naming Conventions
118118

119-
Tests are found in the [tests](https://github.com/executablebooks/MyST-NB/tree/master/tests) directory. In order for `pytest` to find the test scripts correctly, the name of each test script should start with `test_` prefix.
119+
Tests are found in the [tests](https://github.com/executablebooks/MyST-NB/tree/main/tests) directory. In order for `pytest` to find the test scripts correctly, the name of each test script should start with `test_` prefix.
120120

121121
### How to Write Tests
122122

123-
There are many examples of unit tests under the [tests](https://github.com/executablebooks/MyST-NB/tree/master/tests) directory, so reading some of them is a good and recommended way. Prefer using the `fixtures` and the classes defined in [conftest.py](https://github.com/executablebooks/MyST-NB/blob/master/tests/conftest.py) as much as possible.
123+
There are many examples of unit tests under the [tests](https://github.com/executablebooks/MyST-NB/tree/main/tests) directory, so reading some of them is a good and recommended way. Prefer using the `fixtures` and the classes defined in [conftest.py](https://github.com/executablebooks/MyST-NB/blob/main/tests/conftest.py) as much as possible.
124124

125125
If using [pytest-regression](https://pytest-regressions.readthedocs.io/en/latest/), a new directory with `test_` prefix is expected to be created in the first test run. This will store your expected output against which subsequent test outputs will be compared.
126126

127127
### Code Coverage report
128128

129129
[pytest-cov](https://pytest-cov.readthedocs.io/en/latest/) is used to generate code coverage report. Make sure that your test cases cover most of the code written by you.
130130

131-
[github-ci]: https://github.com/executablebooks/MyST-NB/workflows/continuous-integration/badge.svg?branch=master
131+
[github-ci]: https://github.com/executablebooks/MyST-NB/workflows/continuous-integration/badge.svg?branch=main
132132
[github-link]: https://github.com/executablebooks/MyST-NB
133-
[codecov-badge]: https://codecov.io/gh/executablebooks/MyST-NB/branch/master/graph/badge.svg
133+
[codecov-badge]: https://codecov.io/gh/executablebooks/MyST-NB/branch/main/graph/badge.svg
134134
[codecov-link]: https://codecov.io/gh/executablebooks/MyST-NB
135135
[rtd-badge]: https://readthedocs.org/projects/myst-nb/badge/?version=latest
136136
[rtd-link]: https://myst-nb.readthedocs.io/en/latest/?badge=latest

0 commit comments

Comments
 (0)