Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

Commit b759438

Browse files
committed
housekeeping: Rename master to main
Rename and then checkout anything that doesn't apply .. code-block:: console $ sed -i 's/master/main/g' $(git ls-files) $ sed -i 's/MASTER/MAIN/g' $(git ls-files) $ git checkout -p -- Related: #984 Signed-off-by: John Andersen <johnandersenpdx@gmail.com>
1 parent b892cfa commit b759438

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+177
-177
lines changed

.ci/dffml-install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22
set -xe
33

4-
if [ "x${DFFML_RELEASE}" == "xmaster" ]; then
4+
if [ "x${DFFML_RELEASE}" == "xmain" ]; then
55
pip install -e .[dev]
66
dffml service dev install
77
elif [ "x${DFFML_RELEASE}" == "xlatest" ]; then

.ci/run.sh

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ function run_changelog() {
171171
exit 0
172172
fi
173173
# Ensure the number of lines added in the changelog is not 0
174-
added_to_changelog=$(git diff origin/master --numstat -- CHANGELOG.md \
174+
added_to_changelog=$(git diff origin/main --numstat -- CHANGELOG.md \
175175
| awk '{print $1}')
176176
if [ "x$added_to_changelog" == "x" ] || [ "$added_to_changelog" -eq 0 ]; then
177177
echo "No changes to CHANGELOG.md" >&2
@@ -206,7 +206,7 @@ function run_style() {
206206
function run_commit(){
207207
BRANCH="$(echo $GITHUB_REF | cut -d'/' -f 3)"
208208
echo "On Branch: ${BRANCH}"
209-
if [[ "$BRANCH" != "master" ]]; then
209+
if [[ "$BRANCH" != "main" ]]; then
210210
dffml service dev lint commits
211211
fi
212212
}
@@ -245,13 +245,13 @@ function run_docs() {
245245
exit 1
246246
fi
247247

248-
# Make master docs
249-
master_docs="$(mktemp -d)"
250-
TEMP_DIRS+=("${master_docs}")
248+
# Make main docs
249+
main_docs="$(mktemp -d)"
250+
TEMP_DIRS+=("${main_docs}")
251251
rm -rf pages
252252
dffml service dev docs || ./scripts/docs.sh
253253

254-
mv pages "${master_docs}/html"
254+
mv pages "${main_docs}/html"
255255

256256
# Make last release docs
257257
release_docs="$(mktemp -d)"
@@ -276,14 +276,14 @@ function run_docs() {
276276
"${release_docs}/old-gh-pages-branch"
277277

278278
mv "${release_docs}/old-gh-pages-branch/.git" "${release_docs}/html/"
279-
mv "${master_docs}/html" "${release_docs}/html/master"
279+
mv "${main_docs}/html" "${release_docs}/html/main"
280280

281281
# Make webui
282282
git clone https://github.com/intel/dffml -b webui "${release_docs}/webui"
283283
cd "${release_docs}/webui/service/webui/webui"
284284
yarn install
285285
yarn build
286-
mv build/ "${release_docs}/html/master/webui"
286+
mv build/ "${release_docs}/html/main/webui"
287287

288288
cd "${release_docs}/html"
289289

@@ -293,8 +293,8 @@ function run_docs() {
293293
git add -A
294294
git commit -sam "docs: $(date)"
295295

296-
# Don't push docs unless we're running on master
297-
if [ "x${GITHUB_ACTIONS}" == "xtrue" ] && [ "x${GITHUB_REF}" != "xrefs/heads/master" ]; then
296+
# Don't push docs unless we're running on main
297+
if [ "x${GITHUB_ACTIONS}" == "xtrue" ] && [ "x${GITHUB_REF}" != "xrefs/heads/main" ]; then
298298
return
299299
fi
300300

@@ -312,15 +312,15 @@ function run_docs() {
312312
cd -
313313

314314
git reset --hard HEAD
315-
git checkout master
315+
git checkout main
316316
}
317317

318318
function run_lines() {
319319
"${PYTHON}" ./scripts/check_literalincludes.py
320320
}
321321

322322
function run_container() {
323-
docker build --build-arg DFFML_RELEASE=master -t intelotc/dffml .
323+
docker build --build-arg DFFML_RELEASE=main -t intelotc/dffml .
324324
docker run --rm intelotc/dffml version
325325
docker run --rm intelotc/dffml service dev entrypoints list dffml.model
326326
}

.github/ISSUE_TEMPLATE/gsoc_project_idea.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,20 +60,20 @@ Intermediate/Hard
6060

6161
## Related Readings
6262

63-
- https://github.com/intel/dffml/blob/master/docs/contributing/gsoc/2021.md
63+
- https://github.com/intel/dffml/blob/main/docs/contributing/gsoc/2021.md
6464
- https://scikit-learn.org/stable/model_selection.html#model-selection
6565
- https://www.automl.org/automl/
6666

6767
## Getting Started
6868

6969
- Read the contributing guidelines
70-
- https://intel.github.io/dffml/master/contributing/index.html
70+
- https://intel.github.io/dffml/main/contributing/index.html
7171
- Go through the quickstart
72-
- https://intel.github.io/dffml/master/quickstart/model.html
72+
- https://intel.github.io/dffml/main/quickstart/model.html
7373
- Go trough the model tutorials
74-
- https://intel.github.io/dffml/master/tutorials/models/
74+
- https://intel.github.io/dffml/main/tutorials/models/
7575
- Go through the model plugins
76-
- https://intel.github.io/dffml/master/plugins/dffml_model.html
76+
- https://intel.github.io/dffml/main/plugins/dffml_model.html
7777
- You don't need to go through all of them. Just get a feel for running a few
7878

7979
## Potential Mentors

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
317317
- `allowempty` added to source config parameters.
318318
- Quickstart document to show how to use models from Python.
319319
- The latest release of the documentation now includes a link to the
320-
documentation for the master branch (on GitHub pages).
320+
documentation for the main branch (on GitHub pages).
321321
- Virtual environment, GitPod, and Docker development environment setup notes to
322322
the CONTRIBUTING.md file.
323323
- Changelog now included in documentation website.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Contributing
22

3-
Please see the [contributing docs page](https://intel.github.io/dffml/master/contributing/).
3+
Please see the [contributing docs page](https://intel.github.io/dffml/main/contributing/).

Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ RUN apt-get update && \
8787
#
8888
# Here we install DFFML and all the plugins
8989

90-
# The release of dffml we're using, latest is the latest PyPi release, master is
91-
# the master branch
90+
# The release of dffml we're using, latest is the latest PyPi release, main is
91+
# the main branch
9292
ARG DFFML_RELEASE=latest
9393
ENV DFFML_RELEASE ${DFFML_RELEASE}
9494

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
![Logo-dark](https://raw.githubusercontent.com/intel/dffml/master/docs/images/logo-darkmode.svg#gh-dark-mode-only)
2-
![Logo-light](https://raw.githubusercontent.com/intel/dffml/master/docs/images/logo-lightmode.svg#gh-light-mode-only)
3-
[![Actions Status](https://github.com/intel/dffml/workflows/Tests/badge.svg?branch=master&event=push)](https://github.com/intel/dffml/actions)
1+
![Logo-dark](https://raw.githubusercontent.com/intel/dffml/main/docs/images/logo-darkmode.svg#gh-dark-mode-only)
2+
![Logo-light](https://raw.githubusercontent.com/intel/dffml/main/docs/images/logo-lightmode.svg#gh-light-mode-only)
3+
[![Actions Status](https://github.com/intel/dffml/workflows/Tests/badge.svg?branch=main&event=push)](https://github.com/intel/dffml/actions)
44
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/intel/dffml)
5-
[![codecov](https://codecov.io/gh/intel/dffml/branch/master/graph/badge.svg)](https://codecov.io/gh/intel/dffml)
5+
[![codecov](https://codecov.io/gh/intel/dffml/branch/main/graph/badge.svg)](https://codecov.io/gh/intel/dffml)
66
[![CII](https://bestpractices.coreinfrastructure.org/projects/2594/badge)](https://bestpractices.coreinfrastructure.org/projects/2594)
77
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/dffml/community)
88
[![PyPI version](https://img.shields.io/pypi/v/dffml.svg)](https://pypi.org/project/dffml)
@@ -21,12 +21,12 @@ We broadly have two types of audience here, one is Citizen Data Scientists and M
2121

2222
Documentation for the latest release is hosted at https://intel.github.io/dffml/
2323

24-
Documentation for the master branch is hosted at
25-
https://intel.github.io/dffml/master/index.html
24+
Documentation for the main branch is hosted at
25+
https://intel.github.io/dffml/main/index.html
2626

2727
## Contributing
2828

29-
The [contributing page](https://intel.github.io/dffml/master/contributing/index.html)
29+
The [contributing page](https://intel.github.io/dffml/main/contributing/index.html)
3030
will guide you through getting setup and contributing to DFFML.
3131

3232
## Help

configloader/image/setup_common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
author_email=AUTHOR_EMAIL,
4040
maintainer=AUTHOR_NAME,
4141
maintainer_email=AUTHOR_EMAIL,
42-
url=f"https://github.com/dffml/blob/master/configloader/image/README.md",
42+
url=f"https://github.com/dffml/blob/main/configloader/image/README.md",
4343
license="MIT",
4444
keywords=["dffml"],
4545
classifiers=[

configloader/yaml/setup_common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
author_email=AUTHOR_EMAIL,
4040
maintainer=AUTHOR_NAME,
4141
maintainer_email=AUTHOR_EMAIL,
42-
url="https://github.com/intel/dffml/blob/master/configloader/yaml/README.md",
42+
url="https://github.com/intel/dffml/blob/main/configloader/yaml/README.md",
4343
license="MIT",
4444
keywords=["dffml"],
4545
classifiers=[

dffml/service/dev.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -877,8 +877,8 @@ async def _get_file_mutations(self):
877877
return mutations
878878

879879
async def _get_relevant_commits(self):
880-
#! This needs to change when master is renamed to main.
881-
cmd = ["git", "cherry", "-v", "origin/master"]
880+
#! This needs to change when main is renamed to main.
881+
cmd = ["git", "cherry", "-v", "origin/main"]
882882
commits = await get_cmd_output(cmd)
883883
commits_list = [
884884
" ".join(line.split()[2:]) for line in commits.split("\n")

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
nbsphinx_prolog = r"""
8989
{% set docname = env.doc2path(env.docname, base=None) %}
9090
{% if "." not in env.config.release %}
91-
{% set nb_version = "master/" %}
91+
{% set nb_version = "main/" %}
9292
{% endif %}
9393
9494
.. image:: ../../images/Download-.ipynb-button.svg
@@ -108,7 +108,7 @@
108108
html_context = {
109109
"github_user": "intel",
110110
"github_repo": "dffml",
111-
"github_version": "master",
111+
"github_version": "main",
112112
"conf_py_path": "/docs/",
113113
"display_github": True,
114114
}

docs/contributing/dev_env.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,17 @@ development mode.
3232

3333
There are two versions of this documentation.
3434

35-
The version you want is https://intel.github.io/dffml/master/ if you are
35+
The version you want is https://intel.github.io/dffml/main/ if you are
3636
working on DFFML itself.
3737

3838
When working from the Git version of DFFML, the documentation URL you're
39-
looking at should say ``/master/`` in the URL. The URL you are currently on
40-
should be https://intel.github.io/dffml/master/contributing/dev_env.html
39+
looking at should say ``/main/`` in the URL. The URL you are currently on
40+
should be https://intel.github.io/dffml/main/contributing/dev_env.html
4141

42-
This docs without ``/master/`` in the URL are built from the latest release.
42+
This docs without ``/main/`` in the URL are built from the latest release.
4343

44-
The docs with ``/master/`` in the URL are built from the *master* branch.
45-
The master branch is what you get when you clone the Git repo, which we're
44+
The docs with ``/main/`` in the URL are built from the *main* branch.
45+
The main branch is what you get when you clone the Git repo, which we're
4646
about to do.
4747

4848
Installing to your home directory will reduce permissions issues. To do

docs/contributing/git.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ to do your work on.
2323
.. code-block:: console
2424
2525
$ git fetch origin
26-
$ git checkout -b my_new_thing origin/master
26+
$ git checkout -b my_new_thing origin/main
2727
2828
You need to have your own version of DFFML to track your work. Log in to your
2929
Github account and go to `DFFML <https://github.com/intel/dffml>`_ repository.
@@ -96,7 +96,7 @@ review your work or help you figure out what might be going wrong or how you
9696
could solve an issue your stuck on.
9797

9898
Before you are get help, a review, or a final review, make sure to fetch the
99-
latest changes from the master branch and ``merge`` or ``rebase`` them into your
99+
latest changes from the main branch and ``merge`` or ``rebase`` them into your
100100
branch.
101101

102102
When you are ready for final review, remove the ``WIP:`` prefix or draft status.
@@ -140,13 +140,13 @@ is okay.
140140
+--------------+---------------------------------------------------------------+
141141
| LINES | A python file was changed that has specific lines referenced |
142142
| | by a ``.rst`` file. If one of the files is not true, its |
143-
| | because you need to merge or rebase origin/master into your |
143+
| | because you need to merge or rebase origin/main into your |
144144
| | branch. |
145145
+--------------+---------------------------------------------------------------+
146146

147147
For the tests in the various plugins:
148148

149-
- You need to grab the latests changes from the master branch. Maybe you need to
149+
- You need to grab the latests changes from the main branch. Maybe you need to
150150
adapt to them, for example if something got renamed, check the changelog.
151151

152152
- You need to add any dependencies (``pip install ...``) you need to the

docs/contributing/gsoc/2019.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@ We currently have three project ideas, you can read about them and discuss in th
5656
If you've got a brilliant idea you'd like to propose, please make a new issue with the `gsoc` and `project` tags to discuss it! Students are also welcome to add "stretch goal" ideas to their application if they'd like to start with one of our ideas but have a few extra feature ideas of their own they'd like to work on at the end of the summer if everything stays on schedule. [Take a look at the current open issues to see what users want](https://github.com/intel/dffml/issues). Issues which we've talked to someone who would use this as a part of their product or service for their business have the label `customer`. Those are cool because we know they will get used!
5757

5858
## Getting Started
59-
- Follow the [README](https://github.com/intel/dffml/blob/master/README.md) and make sure you can run the tensorflow and git examples, Looking at the [Travis CI](https://travis-ci.org/intel/dffml) may come in handy here.
60-
- [Run the tests](https://github.com/intel/dffml/tree/master/tests). DFFML has unit tests which are at about 90% coverage (amount of lines of code tested) for the main library, the [Git features](https://github.com/intel/dffml/tree/master/feature/git/tests), and the [Tensorflow model](https://github.com/intel/dffml/tree/master/model/tensorflow/tests). Make sure you know how to run them, and if you've never done Python unittests before you might want to [read up on python's unittest library](https://docs.python.org/3/library/unittest.html). Figure out how to run a single test! Running one test instead of all of them will speed up your workflow when you are writing your tests!
59+
- Follow the [README](https://github.com/intel/dffml/blob/main/README.md) and make sure you can run the tensorflow and git examples, Looking at the [Travis CI](https://travis-ci.org/intel/dffml) may come in handy here.
60+
- [Run the tests](https://github.com/intel/dffml/tree/main/tests). DFFML has unit tests which are at about 90% coverage (amount of lines of code tested) for the main library, the [Git features](https://github.com/intel/dffml/tree/main/feature/git/tests), and the [Tensorflow model](https://github.com/intel/dffml/tree/main/model/tensorflow/tests). Make sure you know how to run them, and if you've never done Python unittests before you might want to [read up on python's unittest library](https://docs.python.org/3/library/unittest.html). Figure out how to run a single test! Running one test instead of all of them will speed up your workflow when you are writing your tests!
6161
- Make your first contribution!
6262
- Work on anything labeled [good first issue](https://github.com/intel/dffml/labels/good%20first%20issue).
6363
- Help us increase the test coverage in any of the packages (check out the python package `coverage` to learn how to do this).
64-
- Write a [new feature](https://github.com/intel/dffml/issues/13)! Features can do anything you want, they generate some data based on a unique key, think of them like a scraper, see the [new feature guide](https://github.com/intel/dffml/tree/master/docs/tutorial/FEATURE.md) for more info. Make sure to include tests!
65-
- Write a [new model](https://github.com/intel/dffml/issues/29)! Models are wrappers around any machine learning implementation or library, see the [new model guide](https://github.com/intel/dffml/tree/master/docs/tutorial/MODEL.md) for more info. Make sure to include tests!
64+
- Write a [new feature](https://github.com/intel/dffml/issues/13)! Features can do anything you want, they generate some data based on a unique key, think of them like a scraper, see the [new feature guide](https://github.com/intel/dffml/tree/main/docs/tutorial/FEATURE.md) for more info. Make sure to include tests!
65+
- Write a [new model](https://github.com/intel/dffml/issues/29)! Models are wrappers around any machine learning implementation or library, see the [new model guide](https://github.com/intel/dffml/tree/main/docs/tutorial/MODEL.md) for more info. Make sure to include tests!
6666

6767
## Writing your GSoC application
6868
Instructions on [How to apply](http://python-gsoc.org/#apply) can be found on the Python GSoC website.

docs/contributing/gsoc/2021/archive_storage.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@ Beginner/Intermediate
2121

2222
## Related Readings
2323

24-
- https://intel.github.io/dffml/master/contributing/gsoc/2021/
24+
- https://intel.github.io/dffml/main/contributing/gsoc/2021/
2525

2626
## Getting Started
2727

2828
- Read the contributing guidelines
29-
- https://intel.github.io/dffml/master/contributing/index.html
29+
- https://intel.github.io/dffml/main/contributing/index.html
3030
- Go through the quickstart
31-
- https://intel.github.io/dffml/master/quickstart/model.html
31+
- https://intel.github.io/dffml/main/quickstart/model.html
3232
- Go trough the model tutorials
33-
- https://intel.github.io/dffml/master/tutorials/models/
33+
- https://intel.github.io/dffml/main/tutorials/models/
3434
- Go through the model plugins
35-
- https://intel.github.io/dffml/master/plugins/dffml_model.html
35+
- https://intel.github.io/dffml/main/plugins/dffml_model.html
3636
- Start programming to understand better what will need to happen. The following
3737
is a rough guide meant to give you some activities that will help you better
3838
understand what needs to be done so you can write a more complete proposal.

docs/contributing/gsoc/2021/automl.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,20 +47,20 @@ Intermediate/Hard
4747

4848
## Related Readings
4949

50-
- https://github.com/intel/dffml/blob/master/docs/contributing/gsoc/2021.md
50+
- https://github.com/intel/dffml/blob/main/docs/contributing/gsoc/2021.md
5151
- https://scikit-learn.org/stable/model_selection.html#model-selection
5252
- https://www.automl.org/automl/
5353

5454
## Getting Started
5555

5656
- Read the contributing guidelines
57-
- https://intel.github.io/dffml/master/contributing/index.html
57+
- https://intel.github.io/dffml/main/contributing/index.html
5858
- Go through the quickstart
59-
- https://intel.github.io/dffml/master/quickstart/model.html
59+
- https://intel.github.io/dffml/main/quickstart/model.html
6060
- Go trough the model tutorials
61-
- https://intel.github.io/dffml/master/tutorials/models/
61+
- https://intel.github.io/dffml/main/tutorials/models/
6262
- Go through the model plugins
63-
- https://intel.github.io/dffml/master/plugins/dffml_model.html
63+
- https://intel.github.io/dffml/main/plugins/dffml_model.html
6464

6565
## Potential Mentors
6666

0 commit comments

Comments
 (0)