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

Commit

Permalink
housekeeping: Rename master to main
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
pdxjohnny committed Mar 12, 2022
1 parent b892cfa commit b759438
Show file tree
Hide file tree
Showing 52 changed files with 177 additions and 177 deletions.
2 changes: 1 addition & 1 deletion .ci/dffml-install.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
set -xe

if [ "x${DFFML_RELEASE}" == "xmaster" ]; then
if [ "x${DFFML_RELEASE}" == "xmain" ]; then
pip install -e .[dev]
dffml service dev install
elif [ "x${DFFML_RELEASE}" == "xlatest" ]; then
Expand Down
24 changes: 12 additions & 12 deletions .ci/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ function run_changelog() {
exit 0
fi
# Ensure the number of lines added in the changelog is not 0
added_to_changelog=$(git diff origin/master --numstat -- CHANGELOG.md \
added_to_changelog=$(git diff origin/main --numstat -- CHANGELOG.md \
| awk '{print $1}')
if [ "x$added_to_changelog" == "x" ] || [ "$added_to_changelog" -eq 0 ]; then
echo "No changes to CHANGELOG.md" >&2
Expand Down Expand Up @@ -206,7 +206,7 @@ function run_style() {
function run_commit(){
BRANCH="$(echo $GITHUB_REF | cut -d'/' -f 3)"
echo "On Branch: ${BRANCH}"
if [[ "$BRANCH" != "master" ]]; then
if [[ "$BRANCH" != "main" ]]; then
dffml service dev lint commits
fi
}
Expand Down Expand Up @@ -245,13 +245,13 @@ function run_docs() {
exit 1
fi

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

mv pages "${master_docs}/html"
mv pages "${main_docs}/html"

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

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

# Make webui
git clone https://github.com/intel/dffml -b webui "${release_docs}/webui"
cd "${release_docs}/webui/service/webui/webui"
yarn install
yarn build
mv build/ "${release_docs}/html/master/webui"
mv build/ "${release_docs}/html/main/webui"

cd "${release_docs}/html"

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

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

Expand All @@ -312,15 +312,15 @@ function run_docs() {
cd -

git reset --hard HEAD
git checkout master
git checkout main
}

function run_lines() {
"${PYTHON}" ./scripts/check_literalincludes.py
}

function run_container() {
docker build --build-arg DFFML_RELEASE=master -t intelotc/dffml .
docker build --build-arg DFFML_RELEASE=main -t intelotc/dffml .
docker run --rm intelotc/dffml version
docker run --rm intelotc/dffml service dev entrypoints list dffml.model
}
Expand Down
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/gsoc_project_idea.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,20 @@ Intermediate/Hard

## Related Readings

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

## Getting Started

- Read the contributing guidelines
- https://intel.github.io/dffml/master/contributing/index.html
- https://intel.github.io/dffml/main/contributing/index.html
- Go through the quickstart
- https://intel.github.io/dffml/master/quickstart/model.html
- https://intel.github.io/dffml/main/quickstart/model.html
- Go trough the model tutorials
- https://intel.github.io/dffml/master/tutorials/models/
- https://intel.github.io/dffml/main/tutorials/models/
- Go through the model plugins
- https://intel.github.io/dffml/master/plugins/dffml_model.html
- https://intel.github.io/dffml/main/plugins/dffml_model.html
- You don't need to go through all of them. Just get a feel for running a few

## Potential Mentors
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `allowempty` added to source config parameters.
- Quickstart document to show how to use models from Python.
- The latest release of the documentation now includes a link to the
documentation for the master branch (on GitHub pages).
documentation for the main branch (on GitHub pages).
- Virtual environment, GitPod, and Docker development environment setup notes to
the CONTRIBUTING.md file.
- Changelog now included in documentation website.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Contributing

Please see the [contributing docs page](https://intel.github.io/dffml/master/contributing/).
Please see the [contributing docs page](https://intel.github.io/dffml/main/contributing/).
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ RUN apt-get update && \
#
# Here we install DFFML and all the plugins

# The release of dffml we're using, latest is the latest PyPi release, master is
# the master branch
# The release of dffml we're using, latest is the latest PyPi release, main is
# the main branch
ARG DFFML_RELEASE=latest
ENV DFFML_RELEASE ${DFFML_RELEASE}

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

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

Documentation for the master branch is hosted at
https://intel.github.io/dffml/master/index.html
Documentation for the main branch is hosted at
https://intel.github.io/dffml/main/index.html

## Contributing

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

## Help
Expand Down
2 changes: 1 addition & 1 deletion configloader/image/setup_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
author_email=AUTHOR_EMAIL,
maintainer=AUTHOR_NAME,
maintainer_email=AUTHOR_EMAIL,
url=f"https://github.com/dffml/blob/master/configloader/image/README.md",
url=f"https://github.com/dffml/blob/main/configloader/image/README.md",
license="MIT",
keywords=["dffml"],
classifiers=[
Expand Down
2 changes: 1 addition & 1 deletion configloader/yaml/setup_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
author_email=AUTHOR_EMAIL,
maintainer=AUTHOR_NAME,
maintainer_email=AUTHOR_EMAIL,
url="https://github.com/intel/dffml/blob/master/configloader/yaml/README.md",
url="https://github.com/intel/dffml/blob/main/configloader/yaml/README.md",
license="MIT",
keywords=["dffml"],
classifiers=[
Expand Down
4 changes: 2 additions & 2 deletions dffml/service/dev.py
Original file line number Diff line number Diff line change
Expand Up @@ -877,8 +877,8 @@ async def _get_file_mutations(self):
return mutations

async def _get_relevant_commits(self):
#! This needs to change when master is renamed to main.
cmd = ["git", "cherry", "-v", "origin/master"]
#! This needs to change when main is renamed to main.
cmd = ["git", "cherry", "-v", "origin/main"]
commits = await get_cmd_output(cmd)
commits_list = [
" ".join(line.split()[2:]) for line in commits.split("\n")
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
nbsphinx_prolog = r"""
{% set docname = env.doc2path(env.docname, base=None) %}
{% if "." not in env.config.release %}
{% set nb_version = "master/" %}
{% set nb_version = "main/" %}
{% endif %}
.. image:: ../../images/Download-.ipynb-button.svg
Expand All @@ -108,7 +108,7 @@
html_context = {
"github_user": "intel",
"github_repo": "dffml",
"github_version": "master",
"github_version": "main",
"conf_py_path": "/docs/",
"display_github": True,
}
Expand Down
12 changes: 6 additions & 6 deletions docs/contributing/dev_env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,17 @@ development mode.

There are two versions of this documentation.

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

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

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

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

Installing to your home directory will reduce permissions issues. To do
Expand Down
8 changes: 4 additions & 4 deletions docs/contributing/git.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ to do your work on.
.. code-block:: console
$ git fetch origin
$ git checkout -b my_new_thing origin/master
$ git checkout -b my_new_thing origin/main
You need to have your own version of DFFML to track your work. Log in to your
Github account and go to `DFFML <https://github.com/intel/dffml>`_ repository.
Expand Down Expand Up @@ -96,7 +96,7 @@ review your work or help you figure out what might be going wrong or how you
could solve an issue your stuck on.

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

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

For the tests in the various plugins:

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

- You need to add any dependencies (``pip install ...``) you need to the
Expand Down
8 changes: 4 additions & 4 deletions docs/contributing/gsoc/2019.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ We currently have three project ideas, you can read about them and discuss in th
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!

## Getting Started
- 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.
- [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!
- 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.
- [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!
- Make your first contribution!
- Work on anything labeled [good first issue](https://github.com/intel/dffml/labels/good%20first%20issue).
- Help us increase the test coverage in any of the packages (check out the python package `coverage` to learn how to do this).
- 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!
- 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!
- 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!
- 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!

## Writing your GSoC application
Instructions on [How to apply](http://python-gsoc.org/#apply) can be found on the Python GSoC website.
Expand Down
10 changes: 5 additions & 5 deletions docs/contributing/gsoc/2021/archive_storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,18 @@ Beginner/Intermediate

## Related Readings

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

## Getting Started

- Read the contributing guidelines
- https://intel.github.io/dffml/master/contributing/index.html
- https://intel.github.io/dffml/main/contributing/index.html
- Go through the quickstart
- https://intel.github.io/dffml/master/quickstart/model.html
- https://intel.github.io/dffml/main/quickstart/model.html
- Go trough the model tutorials
- https://intel.github.io/dffml/master/tutorials/models/
- https://intel.github.io/dffml/main/tutorials/models/
- Go through the model plugins
- https://intel.github.io/dffml/master/plugins/dffml_model.html
- https://intel.github.io/dffml/main/plugins/dffml_model.html
- Start programming to understand better what will need to happen. The following
is a rough guide meant to give you some activities that will help you better
understand what needs to be done so you can write a more complete proposal.
Expand Down
10 changes: 5 additions & 5 deletions docs/contributing/gsoc/2021/automl.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,20 +47,20 @@ Intermediate/Hard

## Related Readings

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

## Getting Started

- Read the contributing guidelines
- https://intel.github.io/dffml/master/contributing/index.html
- https://intel.github.io/dffml/main/contributing/index.html
- Go through the quickstart
- https://intel.github.io/dffml/master/quickstart/model.html
- https://intel.github.io/dffml/main/quickstart/model.html
- Go trough the model tutorials
- https://intel.github.io/dffml/master/tutorials/models/
- https://intel.github.io/dffml/main/tutorials/models/
- Go through the model plugins
- https://intel.github.io/dffml/master/plugins/dffml_model.html
- https://intel.github.io/dffml/main/plugins/dffml_model.html

## Potential Mentors

Expand Down
Loading

0 comments on commit b759438

Please sign in to comment.