Skip to content

Commit 086bbd2

Browse files
authored
Merge pull request #144 from CitrineInformatics/admin/rename-master-main
Replace all references to `master` with `main`
2 parents 23a2852 + 04ba9f0 commit 086bbd2

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ script:
1313
- flake8 gemd
1414
- cd docs; make html; cd ..;
1515
- touch ./docs/_build/html/.nojekyll
16-
- if [ "$TRAVIS_PULL_REQUEST" != "false" ] && [ "$TRAVIS_BRANCH" == "master" ]; then bash ./scripts/validate-version-bump.sh; fi
16+
- if [ "$TRAVIS_PULL_REQUEST" != "false" ] && [ "$TRAVIS_BRANCH" == "main" ]; then bash ./scripts/validate-version-bump.sh; fi
1717
deploy:
1818
- provider: pages
1919
skip_cleanup: true

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,30 @@ For additional (non-binding) inspiration, check out the [Google Python Style Gui
2121

2222
## Branching strategy
2323

24-
This project currently follows a [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow) (i.e. _masterflow_):
25-
* Feature branches and bugfixes are branched off of master and then opened as PRs into master
24+
This project currently follows a [feature branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow):
25+
* Feature branches and bugfixes are branched off of `main` and then opened as PRs into `main`
2626
* Every PR must contain a version bump following [semantic versioning](https://semver.org/)
27-
* Backport branches for historical versions are created as-needed off of master; backports are branched off of and merged into them
27+
* Backport branches for historical versions are created as-needed off of `main`; backports are branched off of and merged into them
2828

2929
During periods of rapid development activity, the branching strategy may change to accommodate it, but it will be kept up to date here.
3030

3131
## Release process
3232

33-
The master branch **does not** continuously deploy to [pypi](https://pypi.org/project/gemd/).
33+
The `main` branch **does not** continuously deploy to [pypi](https://pypi.org/project/gemd/).
3434
Rather, releases are cut explicitly by using [GitHub's releases](https://github.com/CitrineInformatics/gemd-python/releases).
3535
To create a release:
3636
* Catalog the changes in order to inform release notes
3737
* To do this through the GitHub interface:
3838
* Navigate to the [GitHub compare page](https://github.com/CitrineInformatics/gemd-python/compare)
3939
* Set the `base` to the most recent tag (which corresponds to the most recent release)
40-
* Set the `compare` to the commit you want to deploy, typically `master`
40+
* Set the `compare` to the commit you want to deploy, typically `main`
4141
* You can use `git diff` as well, if you prefer
4242
* In another tab, navigate to the [GitHub release creation page](https://github.com/CitrineInformatics/gemd-python/releases/new)
43-
* Set the `Target` to the commit you want to deploy, typically `master`
43+
* Set the `Target` to the commit you want to deploy, typically `main`
4444
* Set the `Tag version` to `v{x.y.z}` where `x.y.z` is the version in [setup.py](setup.py), e.g. `v1.2.3`
4545
* Set the `Release title` to "GEMD v{x.y.z} is released!"
4646
* Populate the release notes with a 1 or 2 sentence summary and `What's New`, `Improvements`, `Fixes`, and `Deprecated` sections, as appropriate
4747

4848
Travis will trigger the deploy due to the addition of the tag.
49-
Only commits on the **master** or backports branches can be released, but it need not be the most recent commit on the branch.
49+
Only commits on the **main** or backports branches can be released, but it need not be the most recent commit on the branch.
5050
The tests contained within this repository are sufficient to verify a release.

docs/source/depth/unit_parsing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ This file contains the most commonly used units and will grow over time.
1010
Requests for support of additional units can be made by opening an issue in the `GEMD-python repository`_ on github.
1111

1212
.. _Pint: https://pint.readthedocs.io/en/0.9/
13-
.. _citrine_en.txt: https://github.com/CitrineInformatics/gemd-python/blob/master/gemd/units/citrine_en.txt
14-
.. _GEMD-python repository: https://github.com/CitrineInformatics/gemd-python
13+
.. _citrine_en.txt: https://github.com/CitrineInformatics/gemd-python/blob/main/gemd/units/citrine_en.txt
14+
.. _GEMD-python repository: https://github.com/CitrineInformatics/gemd-python

scripts/validate-version-bump.sh

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,34 +21,34 @@ extract_patch() {
2121
trap "$(set +eu)" EXIT
2222

2323
CURRENT="$(extract_version $(cat setup.py))"
24-
MASTER="$(extract_version $(git show master:setup.py))"
24+
MAIN="$(extract_version $(git show main:setup.py))"
2525

2626
CURRENT_MAJOR="$(extract_major ${CURRENT})"
2727
CURRENT_MINOR="$(extract_minor ${CURRENT})"
2828
CURRENT_PATCH="$(extract_patch ${CURRENT})"
2929

30-
MASTER_MAJOR="$(extract_major ${MASTER})"
31-
MASTER_MINOR="$(extract_minor ${MASTER})"
32-
MASTER_PATCH="$(extract_patch ${MASTER})"
30+
MAIN_MAJOR="$(extract_major ${MAIN})"
31+
MAIN_MINOR="$(extract_minor ${MAIN})"
32+
MAIN_PATCH="$(extract_patch ${MAIN})"
3333

34-
if [ "${CURRENT_MAJOR}" -gt "${MASTER_MAJOR}" ]; then
34+
if [ "${CURRENT_MAJOR}" -gt "${MAIN_MAJOR}" ]; then
3535
echo "major version bump"
3636
exit 0
37-
elif [ "${CURRENT_MAJOR}" -lt "${MASTER_MAJOR}" ]; then
37+
elif [ "${CURRENT_MAJOR}" -lt "${MAIN_MAJOR}" ]; then
3838
echo "error - major version decreased!"
3939
exit 1
4040
else
41-
if [ "${CURRENT_MINOR}" -gt "${MASTER_MINOR}" ]; then
41+
if [ "${CURRENT_MINOR}" -gt "${MAIN_MINOR}" ]; then
4242
echo "minor version bump"
4343
exit 0
44-
elif [ "${CURRENT_MINOR}" -lt "${MASTER_MINOR}" ]; then
44+
elif [ "${CURRENT_MINOR}" -lt "${MAIN_MINOR}" ]; then
4545
echo "error - minor version decreased!"
4646
exit 2
4747
else
48-
if [ "${CURRENT_PATCH}" -gt "${MASTER_PATCH}" ]; then
48+
if [ "${CURRENT_PATCH}" -gt "${MAIN_PATCH}" ]; then
4949
echo "patch version bump"
5050
exit 0
51-
elif [ "${CURRENT_PATCH}" -lt "${MASTER_PATCH}" ]; then
51+
elif [ "${CURRENT_PATCH}" -lt "${MAIN_PATCH}" ]; then
5252
echo "error - patch version decreased!"
5353
exit 3
5454
else

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33

44
setup(name='gemd',
5-
version='0.18.0',
5+
version='0.18.1',
66
url='http://github.com/CitrineInformatics/gemd-python',
77
description="Python binding for Citrine's GEMD data model",
88
author='Max Hutchinson',

0 commit comments

Comments
 (0)