Skip to content

Commit

Permalink
change master references to main
Browse files Browse the repository at this point in the history
this commit assumes we create a main branch and merge this PR to
main
  • Loading branch information
dhimmel committed Dec 10, 2020
1 parent e189dc0 commit 4eea32b
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![HTML Manuscript](https://img.shields.io/badge/manuscript-HTML-blue.svg)](https://manubot.github.io/rootstock/)
[![PDF Manuscript](https://img.shields.io/badge/manuscript-PDF-blue.svg)](https://manubot.github.io/rootstock/manuscript.pdf)
[![GitHub Actions Status](https://github.com/manubot/rootstock/workflows/Manubot/badge.svg)](https://github.com/manubot/rootstock/actions)
[![Travis Build Status](https://travis-ci.com/manubot/rootstock.svg?branch=master)](https://travis-ci.com/manubot/rootstock)
[![Travis Build Status](https://travis-ci.com/manubot/rootstock.svg?branch=main)](https://travis-ci.com/manubot/rootstock)
<!-- usage note: delete CI badges above for services not used by your manuscript -->

## Manuscript description
Expand Down Expand Up @@ -79,7 +79,7 @@ Whenever a pull request is opened, CI (continuous integration) will test whether
The build process aims to detect common errors, such as invalid citations.
If your pull request build fails, see the CI logs for the cause of failure and revise your pull request accordingly.

When a commit to the `master` branch occurs (for example, when a pull request is merged), CI builds the manuscript and writes the results to the [`gh-pages`](https://github.com/manubot/rootstock/tree/gh-pages) and [`output`](https://github.com/manubot/rootstock/tree/output) branches.
When a commit to the `main` branch occurs (for example, when a pull request is merged), CI builds the manuscript and writes the results to the [`gh-pages`](https://github.com/manubot/rootstock/tree/gh-pages) and [`output`](https://github.com/manubot/rootstock/tree/output) branches.
The `gh-pages` branch uses [GitHub Pages](https://pages.github.com/) to host the following URLs:

+ **HTML manuscript** at https://manubot.github.io/rootstock/
Expand Down
8 changes: 4 additions & 4 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Do not initialize the repository, other than optionally adding a Description.
Next, push your cloned manuscript:

```sh
git push --set-upstream origin master
git push --set-upstream origin main
```

## Continuous integration
Expand Down Expand Up @@ -263,7 +263,7 @@ If the changes look okay, commit and push:
```shell
git add --update
git commit --message "Brand repo to $OWNER/$REPO"
git push origin master
git push origin main
```

You should be good to go now.
Expand All @@ -290,7 +290,7 @@ Second, pull the new commits from rootstock, but do not automerge:
git config remote.rootstock.url || git remote add rootstock https://github.com/manubot/rootstock.git

# pull the new commits from rootstock
git pull --no-ff --no-rebase --no-commit rootstock master
git pull --no-ff --no-rebase --no-commit rootstock main
```

If all goes well, there won't be any conflicts.
Expand All @@ -302,7 +302,7 @@ You may notice changes that affect how items in `content` are processed.
If so, you should edit and stage `content` files as needed.
When there are no longer any unstaged changes, then do `git commit`.

If updating `master` via a pull request, proceed to push the commit to GitHub and open a pull request.
If updating your default branch (i.e. `main` or `master`) via a pull request, proceed to push the commit to GitHub and open a pull request.
Once the pull request is ready to merge, use GitHub's "Create a merge commit" option rather than "Squash and merge" or "Rebase and merge" to preserve the rootstock commit hashes.

The environment for local builds does not automatically update when [`build/environment.yml`](build/environment.yml) changes.
Expand Down
2 changes: 1 addition & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For basic formatting, check out the [CommonMark Help](https://commonmark.org/hel
In addition, Manubot supports an extended version of markdown, tailored for scholarly writing, which includes [Pandoc's Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown) and the extensions discussed below.

The `content/02.delete-me.md` file in the Rootstock repository shows many of the elements and formatting options supported by Manubot.
See the [raw markdown](https://gitlab.com/manubot/rootstock/blob/master/content/02.delete-me.md#L) in this file and compare it to the [rendered manuscript](https://manubot.github.io/rootstock/).
See the [raw markdown](https://gitlab.com/manubot/rootstock/blob/main/content/02.delete-me.md#L) in this file and compare it to the [rendered manuscript](https://manubot.github.io/rootstock/).

Within a paragraph in markdown, single newlines are interpreted as whitespace (same as a space).
A paragraph's source does not need to contain newlines.
Expand Down
2 changes: 1 addition & 1 deletion ci/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Continuous integration tools

This directory contains tools and files for continuous integration (CI).
Specifically, [`deploy.sh`](deploy.sh) runs on successful `master` branch builds that are not pull requests.
Specifically, [`deploy.sh`](deploy.sh) runs on successful `main` branch builds that are not pull requests.
The contents of `../webpage` are committed to the `gh-pages` branch.
The contents of `../output` are committed to the `output` branch.

Expand Down
2 changes: 1 addition & 1 deletion content/02.delete-me.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Loaded from a specific (hashed) version of the image on GitHub.
**A vector `.svg` image loaded from GitHub.**
The parameter `sanitize=true` is necessary to properly load SVGs hosted via GitHub URLs.
White background specified to serve as a backdrop for transparent sections of the image.
](https://raw.githubusercontent.com/manubot/resources/master/test/vector.svg?sanitize=true "Vector image"){#fig:vector-image height=2.5in .white}
](https://raw.githubusercontent.com/manubot/resources/main/test/vector.svg?sanitize=true "Vector image"){#fig:vector-image height=2.5in .white}

## Tables

Expand Down
4 changes: 2 additions & 2 deletions output/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Generated citation / reference files

The `output` branch contains files automatically generated by the manuscript build process.
It consists of the contents of the `output` directory of the `master` branch.
These files are not tracked in `master`, but instead written to the `output` branch by continuous integration builds.
It consists of the contents of the `output` directory of the `main` branch.
These files are not tracked in `main`, but instead written to the `output` branch by continuous integration builds.

## Files

Expand Down
2 changes: 1 addition & 1 deletion webpage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To redirect to the permalink for the latest manuscript version at anytime, use t

## Files

This directory contains the following files, which are mostly ignored on the `master` branch:
This directory contains the following files, which are mostly ignored on the `main` branch:

+ [`index.html`](index.html) is an HTML manuscript.
+ [`manuscript.pdf`](manuscript.pdf) is a PDF manuscript.
Expand Down

0 comments on commit 4eea32b

Please sign in to comment.