Change references from "master" branch to "main" branch by willschlitzer · Pull Request #1360 · GenericMappingTools/pygmt

willschlitzer · 2021-06-25T06:31:26Z

As discussed in #1356, PyGMT is changing its default branch from "master" to "main". This pull request changes the references to "master" in the CI job files, maintenance.md, and the README.

Fixes #1356

Reminders

Run make format and make check to make sure the code follows the style guide.
Add tests for new features or tests that would have caught the bug that you're fixing.
Add new public functions/methods/classes to doc/api/index.rst.
Write detailed docstrings for all functions/methods.
If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

…ranch

.github/workflows/ci_tests_dev.yaml

weiji14 · 2021-06-25T07:39:38Z

.github/workflows/dvc-diff.yml

        echo -e "## Summary of changed images\n" > report.md
        echo -e "This is an auto-generated report of images that have changed on the DVC remote\n" >> report.md
-        dvc diff --show-md master HEAD >> report.md
+        dvc diff --show-md main HEAD >> report.md


This reminds me, we'll need to rename the 'master' branch on https://dagshub.com/GenericMappingTools/pygmt to 'main' too.

doc/maintenance.md

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

maxrjones · 2021-06-25T14:36:49Z

While GitHub will redirect links, I think we should update the links in these files to reflect the new main name as part of this process:

./doc/install.rst
./doc/conf.py
./pygmt/src/x2sys_cross.py
./doc/contributing.md
./doc/external_resources.md
./.github/config.yml

.github/workflows/ci_tests_dev.yaml

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

willschlitzer · 2021-06-28T06:33:41Z

While GitHub will redirect links, I think we should update the links in these files to reflect the new main name as part of this process:
./doc/install.rst
./doc/conf.py
./pygmt/src/x2sys_cross.py
./doc/contributing.md
./doc/external_resources.md
./.github/config.yml

./doc/install.rst and ./pygmt/src/x2sys_cross.py
It looks like the only instance of master is in reference to the GMT branch

maxrjones · 2021-06-28T15:52:20Z

While GitHub will redirect links, I think we should update the links in these files to reflect the new main name as part of this process:
./doc/install.rst
./doc/conf.py
./pygmt/src/x2sys_cross.py
./doc/contributing.md
./doc/external_resources.md
./.github/config.yml
./doc/install.rst and ./pygmt/src/x2sys_cross.py
It looks like the only instance of master is in reference to the GMT branch

sounds good, I did a quick search but didn't spend much time checking the references.

seisman · 2021-07-30T20:50:39Z

Maybe we should give this PR a final review and merge it several days before the v0.4.1 release, so that we can have more time to check if there are any related issues in the upcoming v0.4.1 release.

doc/contributing.md

core-man · 2021-07-31T07:47:22Z

contributing.md still have sentences using master:

Line 98:

our tests. This way, the *master* branch is always stable.

Line 173:

See the [`environment.yml`](https://github.com/GenericMappingTools/pygmt/blob/master/environment.yml)

core-man

I think all "master" are changed to "main" except in some places indicated above. Great~

Co-authored-by: Yao Jiayuan <coreman.seism@gmail.com>

weiji14 · 2021-08-01T10:11:22Z

Besides those mentioned at #1360 (comment), here's a few more:

pygmt/doc/conf.py

Line 117 in 6a4b871

master_doc = "index"
pygmt/doc/_templates/layout.html

Line 35 in 6a4b871

<a href="{{ pathto(master_doc) }}"><h2 class="sidebar-title">{{ project }}</h2></a>
https://github.com/GenericMappingTools/pygmt/blame/v0.4.0/doc/install.rst#L72

willschlitzer · 2021-08-03T19:31:51Z

@weiji14 @core-man I made the changes you requested

seisman · 2021-08-03T23:18:47Z

Besides those mentioned at #1360 (comment), here's a few more:

pygmt/doc/conf.py

Line 117 in 6a4b871

master_doc = "index"

pygmt/doc/_templates/layout.html

Line 35 in 6a4b871

<a href="{{ pathto(master_doc) }}"><h2 class="sidebar-title">{{ project }}</h2></a>

I don't think we can change master_doc to main_doc. It's a sphinx configuration and is used internally by sphinx (see https://github.com/sphinx-doc/sphinx/search?q=master_doc).

EDIT: Sphinx has renamed master_doc to root_doc in sphinx v4.0. We can change master_doc to root_doc here, but it means PyGMT will require sphinx >= 4.0, which was release in May, 2021.

weiji14

Besides those mentioned at #1360 (comment), here's a few more:

pygmt/doc/conf.py

Line 117 in 6a4b871

master_doc = "index"

pygmt/doc/_templates/layout.html

Line 35 in 6a4b871

<a href="{{ pathto(master_doc) }}"><h2 class="sidebar-title">{{ project }}</h2></a>

I don't think we can change master_doc to main_doc. It's a sphinx configuration and is used internally by sphinx (see https://github.com/sphinx-doc/sphinx/search?q=master_doc).

EDIT: Sphinx has renamed master_doc to root_doc in sphinx v4.0. We can change master_doc to root_doc here, but it means PyGMT will require sphinx >= 4.0, which was release in May, 2021.

Was just about to say that root_doc should be used instead. We have sphinx 4.1.2 in CI (https://github.com/GenericMappingTools/pygmt/runs/3235302620?check_suite_focus=true#step:6:187) so it should be fine.

doc/conf.py

doc/_templates/layout.html

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

maxrjones

Does this get merged before or after the actual renaming of the branch?

seisman · 2021-08-04T20:47:37Z

Does this get merged before or after the actual renaming of the branch?

Either should work. I prefer to merge this PR after renaming the branch, so that we can immediately know how renaming the main branch affects PRs.

maxrjones · 2021-08-04T20:51:38Z

Does this get merged before or after the actual renaming of the branch?

Either should work. I prefer to merge this PR after renaming the branch, so that we can immediately know how renaming the main branch affects PRs.

OK, I can rename the branch after the current workflows finish and then ping here to merge in the PR.

maxrjones · 2021-08-04T22:54:03Z

Looks good to merge after checks pass, thanks @willschlitzer!

weiji14 · 2021-08-04T23:52:19Z

Looks good to merge after checks pass, thanks @willschlitzer!

Thanks heaps @willschlitzer! I'll squash and merge this in directly since the "master" -> "main" rename has been done (otherwise the links on https://www.pygmt.org/dev/index.html won't work).

…ngTools#1360) PyGMT is changing its default branch from "master" to "main". This pull request changes the references to "master" in the CI job files, maintenance.md, and the README. * change workflow files to point to "main" branch instead of "master" branch * change README to use "main" branch instead of "master" branch * change maintenance.md use "main" branch instead of "master" branch * update conf.py to use main instead of master * update contributing.md to use main instead of master * update external_resources.md to use main instead of master * update config.yml to use main instead of master * change master_doc to root_doc in conf.py and layout.html Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> Co-authored-by: Dongdong Tian <seisman.info@gmail.com> Co-authored-by: Yao Jiayuan <coreman.seism@gmail.com> Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>

willschlitzer added 3 commits June 25, 2021 07:19

change workflow files to point to "main" branch instead of "master" b…

8702b91

…ranch

change README to use "main" branch instead of "master" branch

4ee8798

change maintenance.md use "main" branch instead of "master" branch

9a5381a

willschlitzer added the maintenance Boring but important stuff for the core devs label Jun 25, 2021

willschlitzer added this to the 0.5.0 milestone Jun 25, 2021

willschlitzer self-assigned this Jun 25, 2021

vercel bot temporarily deployed to Preview June 25, 2021 06:39 Inactive

weiji14 reviewed Jun 25, 2021

View reviewed changes

Apply suggestions from code review

5880d39

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

vercel bot temporarily deployed to Preview June 25, 2021 08:23 Inactive

seisman reviewed Jun 26, 2021

View reviewed changes

.github/workflows/ci_tests_dev.yaml Outdated Show resolved Hide resolved

Apply suggestions from code review

e6e63de

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

vercel bot temporarily deployed to Preview June 28, 2021 06:24 Inactive

willschlitzer added 4 commits June 28, 2021 07:29

update conf.py to use main instead of master

d5fdadc

update contributing.md to use main instead of master

867186d

update external_resources.md to use main instead of master

766f16a

update config.yml to use main instead of master

9c61e5a

vercel bot temporarily deployed to Preview June 28, 2021 06:33 Inactive

willschlitzer marked this pull request as ready for review June 29, 2021 10:03

weiji14 mentioned this pull request Jun 30, 2021

Change main branch from "master" to "main" #1356

Closed

willschlitzer modified the milestones: 0.5.0, 0.4.1 Jul 24, 2021

Merge branch 'master' into new-main-branch

e4b2569

vercel bot temporarily deployed to Preview July 31, 2021 05:20 Inactive

core-man mentioned this pull request Jul 31, 2021

Release PyGMT v0.4.1 #1402

Closed

23 tasks

core-man reviewed Jul 31, 2021

View reviewed changes

doc/contributing.md Outdated Show resolved Hide resolved

core-man approved these changes Jul 31, 2021

View reviewed changes

Update doc/contributing.md

4775c18

Co-authored-by: Yao Jiayuan <coreman.seism@gmail.com>

vercel bot temporarily deployed to Preview August 1, 2021 05:42 Inactive

willschlitzer added 2 commits August 3, 2021 20:29

update contributing.md

58d351e

change master_doc to main_doc in conf.py and layout.html

3ea65e0

vercel bot temporarily deployed to Preview August 3, 2021 19:31 Inactive

weiji14 reviewed Aug 3, 2021

View reviewed changes

doc/conf.py Outdated Show resolved Hide resolved

doc/_templates/layout.html Outdated Show resolved Hide resolved

Apply suggestions from code review

27b4f54

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

vercel bot temporarily deployed to Preview August 4, 2021 18:26 Inactive

weiji14 approved these changes Aug 4, 2021

View reviewed changes

maxrjones approved these changes Aug 4, 2021

View reviewed changes

seisman approved these changes Aug 4, 2021

View reviewed changes

Merge branch 'main' into new-main-branch

31480df

vercel bot temporarily deployed to Preview August 4, 2021 22:52 Inactive

weiji14 merged commit 9cbda9e into main Aug 4, 2021

weiji14 deleted the new-main-branch branch August 4, 2021 23:54

Conversation

willschlitzer commented Jun 25, 2021 • edited by weiji14 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weiji14 Jun 25, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

maxrjones commented Jun 25, 2021

Uh oh!

Uh oh!

willschlitzer commented Jun 28, 2021

Uh oh!

maxrjones commented Jun 28, 2021

Uh oh!

seisman commented Jul 30, 2021

Uh oh!

Uh oh!

core-man commented Jul 31, 2021

Uh oh!

core-man left a comment

Choose a reason for hiding this comment

Uh oh!

weiji14 commented Aug 1, 2021

Uh oh!

willschlitzer commented Aug 3, 2021

Uh oh!

seisman commented Aug 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weiji14 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

maxrjones left a comment

Choose a reason for hiding this comment

Uh oh!

seisman commented Aug 4, 2021

Uh oh!

maxrjones commented Aug 4, 2021

Uh oh!

maxrjones commented Aug 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weiji14 commented Aug 4, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

willschlitzer commented Jun 25, 2021 •

edited by weiji14

Loading

seisman commented Aug 3, 2021 •

edited

Loading

weiji14 left a comment •

edited

Loading

maxrjones commented Aug 4, 2021 •

edited

Loading