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 nbgitpuller repo's master branch to main #189

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
8 changes: 4 additions & 4 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ workflows:
- build_docs
- push_docs:
filters: # using regex filters requires the entire branch to match
branches:
only: # only branches matching the below regex filters will run
- master
branches:
only: # only branches matching the below regex filters will run
- main

commands:
build_site:
Expand All @@ -62,4 +62,4 @@ commands:
name: Build docs to store
command: |
cd docs
make html
make html
14 changes: 7 additions & 7 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ The PyPI release is done automatically by TravisCI when a tag is pushed.

## Steps to make a release

1. Checkout master and make sure it is up to date.
1. Checkout main and make sure it is up to date.

```shell
ORIGIN=${ORIGIN:-origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo
git checkout master
git fetch $ORIGIN master
git reset --hard $ORIGIN/master
git checkout main
git fetch $ORIGIN main
git reset --hard $ORIGIN/main
# WARNING! This next command deletes any untracked files in the repo
git clean -xfd
```
Expand All @@ -38,15 +38,15 @@ The PyPI release is done automatically by TravisCI when a tag is pushed.
git commit -m "back to dev"
```

1. Push your two commits to master.
1. Push your two commits to main.

```shell
# first push commits without a tags to ensure the
# commits comes through, because a tag can otherwise
# be pushed all alone without company of rejected
# commits, and we want have our tagged release coupled
# with a specific commit in master
git push $ORIGIN master
# with a specific commit in main
git push $ORIGIN main
```

1. Create a git tag for the pushed release commit and push it.
Expand Down
12 changes: 6 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ def setup(app):
source_suffix = [".rst", ".md"]


# The master toctree document.
master_doc = "index"
# The root toctree document.
root_doc = master_doc = "index"

# General information about the project.
project = "nbgitpuller"
Expand Down Expand Up @@ -85,7 +85,7 @@ def setup(app):
html_context = {
"github_user": "jupyterhub",
"github_repo": "nbgitpuller",
"github_version": "master",
"github_version": "main",
"doc_path": "doc",
"source_suffix": source_suffix,
}
Expand Down Expand Up @@ -130,7 +130,7 @@ def setup(app):
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(
master_doc,
root_doc,
"nbgitpuller.tex",
"nbgitpuller Documentation",
"The nbgitpuller Team",
Expand All @@ -143,7 +143,7 @@ def setup(app):

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "nbgitpuller", "nbgitpuller Documentation", [author], 1)]
man_pages = [(root_doc, "nbgitpuller", "nbgitpuller Documentation", [author], 1)]


# -- Options for Texinfo output -------------------------------------------
Expand All @@ -153,7 +153,7 @@ def setup(app):
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
root_doc,
"nbgitpuller",
"nbgitpuller Documentation",
author,
Expand Down