Skip to content

Commit 71f3da0

Browse files
braingramhayescr
authored andcommitted
switch default branch name to main in docs/ci (spacetelescope#8210)
1 parent 3cc3d63 commit 71f3da0

File tree

11 files changed

+30
-29
lines changed

11 files changed

+30
-29
lines changed

.github/dependabot.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ updates:
44
# Maintain dependencies for GitHub Actions
55
- package-ecosystem: "github-actions"
66
directory: "/"
7-
target-branch: "master"
7+
target-branch: "main"
88
schedule:
99
interval: "weekly"
1010
reviewers:
@@ -13,7 +13,7 @@ updates:
1313
# Maintain dependencies for pip
1414
- package-ecosystem: "pip"
1515
directory: "/"
16-
target-branch: "master"
16+
target-branch: "main"
1717
schedule:
1818
interval: "weekly"
1919
reviewers:

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ name: test
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77
- '*x'
88
tags:
99
- '*'
1010
pull_request:
1111
branches:
12-
- master
12+
- main
1313
schedule:
1414
# Weekly Monday 9AM build
1515
- cron: "0 9 * * 1"

.github/workflows/tests_devdeps.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ name: test with development versions
33
on:
44
push:
55
branches:
6-
- master
6+
- main
77
- '*x'
88
tags:
99
- '*'
1010
pull_request:
1111
branches:
12-
- master
12+
- main
1313
schedule:
1414
# Weekly Monday 9AM build
1515
- cron: "0 9 * * 1"

CONTRIBUTING.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ opening a new [issue](https://github.com/spacetelescope/jwst/issues).
1515
## Contributing code
1616

1717
If you would like to contribute code, this is done by submitting a [pull request](https://github.com/spacetelescope/jwst/pulls)
18-
to the "master" branch of `spacetelescope/jwst`. To do this, we recommend the
18+
to the "main" branch of `spacetelescope/jwst`. To do this, we recommend the
1919
following workflow (which assumes you already have a Github account / command line tools).
2020
If you are also new to git, please refer to the [git reference manual](https://git-scm.com/docs)
2121
for an overview of git basics.
@@ -33,7 +33,7 @@ First, to clarify some terms that will be commonly used here:
3333
The first step is to create your own 'remote' (online) and 'local' (on your machine)
3434
clones of the central `spacetelescope/jwst` repository. You will make code changes
3535
on your machine to your 'local' clone, push these to 'origin' (your online fork),
36-
and finally, open a pull request to the ''master'' branch of `spacetelescope/jwst`.
36+
and finally, open a pull request to the ''main'' branch of `spacetelescope/jwst`.
3737

3838
1. On the 'spacetelescope/jwst' Github repository page, 'fork' the JWST repository
3939
to your own account space by clicking the appropriate button on the upper right-hand
@@ -77,16 +77,16 @@ If you ever want to reset these URLs, add references to other remote forks of
7777

7878
### Step 2: Creating a branch for your changes
7979

80-
It is a standard practice in git to create a new 'branch' (off `upstream/master`)
80+
It is a standard practice in git to create a new 'branch' (off `upstream/main`)
8181
for each new feature or bug fix. You can call this branch whatever you like - in
8282
this example, we'll call it 'my_feature'. First, make sure you
8383
have all recent changes to upstream by 'fetching' them:
8484

8585
>> git fetch upstream
8686

87-
The following will create a new branch off local/master called 'my_feature', and automatically switch you over to your new branch.
87+
The following will create a new branch off local/main called 'my_feature', and automatically switch you over to your new branch.
8888

89-
>> git checkout -b my_feature upstream/master
89+
>> git checkout -b my_feature upstream/main
9090

9191
### Step 3: Installing `jwst` for development
9292

@@ -149,14 +149,14 @@ you open a pull request, add the corresponding PR number.
149149

150150
### Step 4: Opening a pull request
151151

152-
Now, you can open a pull request on the master branch of the upstream `jwst` repository.
152+
Now, you can open a pull request on the main branch of the upstream `jwst` repository.
153153

154154
1. On the `spacetelescope/jwst` web page, after you push your changes you should
155155
see a large green banner appear at the top prompting you to open a pull request
156156
with your recently pushed changes. You can also open a pull request from the
157157
[pull request tab](https://github.com/spacetelescope/jwst/pulls) on that page.
158158
Select your fork and your 'my_feature' branch, and open a pull request against
159-
the 'master' branch.
159+
the 'main' branch.
160160

161161
2. There is now a checklist of items that need to be done before your PR can be merged.
162162
* The continuous integration (CI) tests must complete and pass. The CI
@@ -177,16 +177,16 @@ the 'master' branch.
177177
## Keeping your development branch current - rebasing
178178

179179
As `jwst` is constantly evolving, you will often encounter the situation where you've
180-
made changes to your branch off 'master', but in the time its taken you to make those
181-
changes, 'upstream/master' has evolved with new commits from other developers. In this
180+
made changes to your branch off 'main', but in the time its taken you to make those
181+
changes, 'upstream/main' has evolved with new commits from other developers. In this
182182
situation, you will want to make sure you incorporate these changes into your branch.
183183
Rebasing allows you to do two things - 1. apply others changes on top of yours, and 2.
184184
squash your commits, even if there aren't new changes to apply.
185185

186186
Periodically, while writing code, to keep your branch up to date you will want to
187-
do an interactive rebase against upstream/master to apply any new changes on top of yours:
187+
do an interactive rebase against upstream/main to apply any new changes on top of yours:
188188

189-
>> git rebase -i upstream/master
189+
>> git rebase -i upstream/main
190190

191191
This will then prompt you to select commits and commit messages - if you select
192192
just the top commit, this will 'squash' the others and combine them into one. You
@@ -204,7 +204,7 @@ commits into a single one, which is also done with `git rebase`
204204
`jwst` uses [sphinx](https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html) to generate documentation, which is then hosted online on [readthedocs](https://readthedocs.org/).
205205

206206
You can access two versions of the documentation on the [JWST readthedocs website](https://readthedocs.org/projects/jwst-pipeline/)
207-
- the 'latest' version is whatever is currently on the master branch, and the 'stable'
207+
- the 'latest' version is whatever is currently on the main branch, and the 'stable'
208208
version is the last released version. If you successfully merge a PR with documentation
209209
changes, they will only appear on 'latest' until the next JWST release.
210210

@@ -329,7 +329,7 @@ last released version of `stcal`, and stcal points to the last version of `jwst`
329329
issue becomes circular. What you will need to do is modify the `pyproject.toml` files in both
330330
packages to point to the other to demonstrate that CI tests pass (and make a comment
331331
noting this in your PR), and then change it back before the PR is merge so that changes
332-
to `pyproject.toml` are not merged into master/main. In your `jwst` branch, to point to your
332+
to `pyproject.toml` are not merged into main. In your `jwst` branch, to point to your
333333
branch in the dependent package (in this example `stcal`), change the required `stcal`
334334
version in `pyproject.toml` to:
335335

JenkinsfileRT

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ withCredentials([string(
4040
jobconfig = new JobConfig()
4141
jobconfig.enable_env_publication = true
4242
jobconfig.publish_env_on_success_only = true
43-
jobconfig.publish_env_filter = "spacetelescope/master"
43+
jobconfig.publish_env_filter = "spacetelescope/main"
4444

4545
// Define python version for conda
4646
python_version = "3.11"

JenkinsfileRT_dev

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ withCredentials([string(
4040
jobconfig = new JobConfig()
4141
jobconfig.enable_env_publication = false
4242
jobconfig.publish_env_on_success_only = true
43-
jobconfig.publish_env_filter = "spacetelescope/master"
43+
jobconfig.publish_env_filter = "spacetelescope/main"
4444

4545
// Define python version for conda
4646
python_version = "3.11"

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# JWST Calibration Pipeline
22

3-
[![Build Status](https://github.com/spacetelescope/jwst/workflows/CI/badge.svg?branch=master)](https://github.com/spacetelescope/jwst/actions)
4-
[![codecov](https://codecov.io/gh/spacetelescope/jwst/branch/master/graph/badge.svg?token=Utf5Zs9g7z)](https://codecov.io/gh/spacetelescope/jwst)
3+
[![Build Status](https://github.com/spacetelescope/jwst/workflows/CI/badge.svg)](https://github.com/spacetelescope/jwst/actions)
4+
[![codecov](https://codecov.io/gh/spacetelescope/jwst/branch/main/graph/badge.svg?token=Utf5Zs9g7z)](https://codecov.io/gh/spacetelescope/jwst)
55
[![Documentation Status](https://readthedocs.org/projects/jwst-pipeline/badge/?version=latest)](http://jwst-pipeline.readthedocs.io/en/latest/?badge=latest)
66
[![Powered by STScI Badge](https://img.shields.io/badge/powered%20by-STScI-blue.svg?colorA=707170&colorB=3e8ddd&style=flat)](http://www.stsci.edu)
77
[![Powered by Astropy Badge](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)
@@ -64,7 +64,7 @@ You can also install a specific version:
6464
### Installing the development version from Github
6565

6666
You can install the latest development version (not as well tested) from the
67-
Github master branch:
67+
Github main branch:
6868

6969
conda create -n <env_name> python=3.11
7070
conda activate <env_name>
@@ -178,7 +178,7 @@ environment variable:
178178

179179
## Documentation
180180

181-
Documentation (built daily from the Github `master` branch) is available at:
181+
Documentation (built daily from the Github `main` branch) is available at:
182182

183183
https://jwst-pipeline.readthedocs.io/en/latest/
184184

changes/8210.general.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Rename default branch to main.

docs/getting_started/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ Contributing and Reporting Issues
33
=================================
44

55
`jwst` is open source - if you would like to contribute code or file an issue,
6-
please see the `the Github Contribution Guide <https://github.com/spacetelescope/jwst/blob/master/CONTRIBUTING.md>`_.
6+
please see the `the Github Contribution Guide <https://github.com/spacetelescope/jwst/blob/main/CONTRIBUTING.md>`_.

docs/getting_started/install.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Installing the Development Version from Github
6969
----------------------------------------------
7070

7171
You can install the latest development version (not as well tested) from the
72-
Github master branch:
72+
Github main branch:
7373

7474
| >> conda create -n <env_name> python=3.11
7575
| >> conda activate <env_name>
@@ -93,7 +93,7 @@ environment of choice and then reinstall:
9393
9494
This will ensure that all dependency packages are also upgraded. This also
9595
applies when using the development version of jwst - to upgrade and grab recent
96-
changes, uninstall and re-install the master branch from Github:
96+
changes, uninstall and re-install the main branch from Github:
9797

9898
| >> pip uninstall jwst
9999
| >> pip install git+https://github.com/spacetelescope/jwst

0 commit comments

Comments
 (0)