-
Notifications
You must be signed in to change notification settings - Fork 215
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Change references from "master" branch to "main" branch #1360
Conversation
@@ -44,7 +44,7 @@ jobs: | |||
run: | | |||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This reminds me, we'll need to rename the 'master' branch on https://dagshub.com/GenericMappingTools/pygmt to 'main' too.
Co-authored-by: Wei Ji <[email protected]>
While GitHub will redirect links, I think we should update the links in these files to reflect the new
|
Co-authored-by: Dongdong Tian <[email protected]>
|
sounds good, I did a quick search but didn't spend much time checking the references. |
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. |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think all "master" are changed to "main" except in some places indicated above. Great~
Co-authored-by: Yao Jiayuan <[email protected]>
Besides those mentioned at #1360 (comment), here's a few more:
|
I don't think we can change EDIT: Sphinx has renamed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Besides those mentioned at #1360 (comment), here's a few more:
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
tomain_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
toroot_doc
in sphinx v4.0. We can changemaster_doc
toroot_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.
Co-authored-by: Wei Ji <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
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 <[email protected]> Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Yao Jiayuan <[email protected]> Co-authored-by: Meghan Jones <[email protected]>
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
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version