Skip to content
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

Rename master branch to main #20

Merged
merged 1 commit into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Documentation

on:
push:
branches: [master]
branches: [main]
pull_request:
branches: ['*']

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Linting

on:
push:
branches: [master]
branches: [main]
pull_request:
branches: ['*']

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pytest-minimal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Test minimal

on:
push:
branches: [master]
branches: [main]
pull_request:
branches: ['*']

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Test latest

on:
push:
branches: [master]
branches: [main]
pull_request:
branches: ['*']

Expand Down
22 changes: 11 additions & 11 deletions HOW_TO_RELEASE
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ How to issue a release in 15 easy steps

Time required: about an hour.

1. Ensure your master branch is synced to origin:
git pull origin master
1. Ensure your main branch is synced to origin:
git pull origin main
2. Look over whats-new.rst and the docs. Make sure "What's New" is complete
(check the date!) and add a brief summary note describing the release at the
top.
3. If you have any doubts, run the full test suite one final time!
py.test
4. On the master branch, commit the release in git:
4. On the main branch, commit the release in git:
git commit -a -m 'Release v0.X.Y'
5. Tag the release:
git tag -a v0.X.Y -m 'v0.X.Y'
Expand All @@ -20,22 +20,22 @@ Time required: about an hour.
twine upload dist/TEMPLATE-0.X.Y*
You will need to be listed as a package owner at
https://pypi.python.org/pypi/TEMPLATE for this to work.
8. Push your changes to master:
git push origin master
8. Push your changes to main:
git push origin main
git push origin --tags
9. Update the stable branch (used by ReadTheDocs) and switch back to master:
9. Update the stable branch (used by ReadTheDocs) and switch back to main:
git checkout stable
git rebase master
git rebase main
git push origin stable
git checkout master
git checkout main
It's OK to force push to 'stable' if necessary.
We also update the stable branch with `git cherrypick` for documentation
only fixes that apply the current released version.
10. Add a section for the next release (v.X.(Y+1)) to doc/whats-new.rst.
11. Commit your changes and push to master again:
11. Commit your changes and push to main again:
git commit -a -m 'Revert to dev version'
git push origin master
You're done pushing to master!
git push origin main
You're done pushing to main!
12. Issue the release on GitHub. Open https://github.com/TODO/TEMPLATE/releases;
the new release should have automatically appeared. Otherwise, click on
"Draft a new release" and paste in the latest from whats-new.rst.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ You may want to move this section to the top of the page!
[![pre-commit-badge](https://github.com/crusaderky/python_project_template/workflows/Linting/badge.svg)](https://github.com/crusaderky/python_project_template/actions)
[![pytest-badge](https://github.com/crusaderky/python_project_template/workflows/Test%20latest/badge.svg)](https://github.com/crusaderky/python_project_template/actions)
[![pytest-minimal-badge](https://github.com/crusaderky/python_project_template/workflows/Test%20minimal/badge.svg)](https://github.com/crusaderky/python_project_template/actions)
[![codecov-badge](https://codecov.io/gh/crusaderky/python_project_template/branch/master/graph/badge.svg)](https://codecov.io/gh/crusaderky/python_project_template/branch/master)
[![codecov-badge](https://codecov.io/gh/crusaderky/python_project_template/branch/main/graph/badge.svg)](https://codecov.io/gh/crusaderky/python_project_template/branch/main)
Loading