Skip to content

Commit

Permalink
Rename main to master (#212)
Browse files Browse the repository at this point in the history
* Rename main to master
* Rename main to master in content
  • Loading branch information
gwarf authored May 12, 2021
1 parent f8cee7a commit 01cb4d1
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ jobs:
check-modified-files-only: "yes"
use-quiet-mode: "yes"
use-verbose-mode: "yes"
base-branch: "master"
base-branch: "main"
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ name: Deploy to GitHub pages
on:
push:
branches:
- master
- main

jobs:
deploy:
Expand Down Expand Up @@ -62,4 +62,4 @@ jobs:
personal_token: ${{ steps.generate-token.outputs.token }}
external_repository: EGI-Federation/EGI-Federation.github.io
cname: docs.egi.eu
publish_branch: master
publish_branch: main
4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: Run Super-Linter on new changes
uses: github/super-linter@v3
env:
DEFAULT_BRANCH: master
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MARKDOWN_CONFIG_FILE: .markdownlint.json
# Only check new or edited files
Expand All @@ -35,7 +35,7 @@ jobs:
- name: Run Super-Linter on all codebase
uses: github/super-linter@v3
env:
DEFAULT_BRANCH: master
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MARKDOWN_CONFIG_FILE: .markdownlint.json
# Check all files
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,6 @@ git commit themes/docsy -m 'Update theme'

## Deployment to the EGI organisation pages

[GitHub Actions](https://github.com/EGI-Federation/documentation/tree/master/.github/workflows)
will automatically deploy a new version when a PR is merged to master,
[GitHub Actions](https://github.com/EGI-Federation/documentation/tree/main/.github/workflows)
will automatically deploy a new version when a PR is merged to main,
it will then be availalbe at [https://docs.egi.eu](https://docs.egi.eu).
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ no = 'Sorry to hear that. Please <a href="https://github.com/EGI-Federation/docu
# XXX Maybe useful to add back this somewhere
# [[menu.shortcuts]]
# name = "<i class='fa fa-cloud-download'></i> <label>Download</label>"
# url = "https://github.com/EGI-Federation/EGI-Federation.github.io/archive/master.zip"
# url = "https://github.com/EGI-Federation/EGI-Federation.github.io/archive/main.zip"
# weight = 11

[markup]
Expand Down
8 changes: 4 additions & 4 deletions content/en/about/contributing/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ contributions.

1. Fork the project if you have not, and commit changes to a git branch.
Documentation on building the documentation locally is available in the
[README.md](https://github.com/EGI-Federation/documentation/blob/master/README.md)
[README.md](https://github.com/EGI-Federation/documentation/blob/main/README.md)
1. Create a GitHub Pull Request for your change, following the instructions in
the Pull Request template.
1. Perform a [Code Review](#code-review-process) with the maintainers on the
Expand Down Expand Up @@ -90,16 +90,16 @@ The process at this point is as follows:
[GitHub Actions](https://github.com/features/actions), successful checks are
a hard requirement, but maintainers will help you addressing reported issues.
1. A maintainer will review your code and merge it if no changes are necessary.
Your change will be merged into the repository's `master` branch.
Your change will be merged into the repository's `main` branch.
1. If a maintainer has feedback or questions on your changes then they will set
`request changes` in the review and provide an explanation.

## Release cycle

The documentation is using a rolling release model, all changes merged to the
`master` branch are directly deployed in the live production environment.
`main` branch are directly deployed in the live production environment.

Master branch is always available. Tagged versions may be created as needed
Main branch is always available. Tagged versions may be created as needed
following [Semantic Versioning](https://semver.org/) as far as applicable.

## Community
Expand Down
22 changes: 11 additions & 11 deletions content/en/about/contributing/git/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ upstream [email protected]:EGI-Federation/documentation.git (push)

The documentation webiste is built from the source files using
[Hugo](https://gohugo.io/). The repository
[README](https://github.com/EGI-Federation/documentation/blob/master/README.md)
[README](https://github.com/EGI-Federation/documentation/blob/main/README.md)
can be used as a reference for building instructions.

### Requirements
Expand Down Expand Up @@ -167,16 +167,16 @@ You should submit your patch as a git branch ideally named with a meaningful
name related to the changes you want to propose. This is called a _feature
branch_ (sometimes also named _topic branch_). You will commit your
modifications to this _feature branch_ and submit a Pull Request (PR) based on
the differences between the upstream master branch and your _feature branch_.
the differences between the upstream main branch and your _feature branch_.

### Creating a feature branch

Try to avoid committing changes to the _master_ branch of your clone to simplify
Try to avoid committing changes to the _main_ branch of your clone to simplify
management, creating a dedicated _feature branch_ helps a lot. Try to pick a
meaningful name for the branch (my_nice_update in the example).

```sh
# This should be done from the up-to-date master branch
# This should be done from the up-to-date main branch
# Read furthermore to see documentation on updating a local clone
git checkout -b my_nice_update
```
Expand Down Expand Up @@ -256,19 +256,19 @@ Then you can commit new changes and push them to your remote fork.
## Updating a repository clone with the upstream changes

```sh
# If you are still in a branch created for a previous PR, move to master
git checkout master
# If you are still in a branch created for a previous PR, move to main
git checkout main
# Get the latest data from the upstream repository
git fetch upstream
# Update your local copy with this data
git rebase upstream/master master
git rebase upstream/main main
# Update your remote GitHub fork with those changes
git push
```

## Updating a local feature branch with changes made on the master branch
## Updating a local feature branch with changes made on the main branch

In case the _master_ branch evolved since the feature branch was created, it may
In case the _main_ branch evolved since the feature branch was created, it may
be required to merge the new changes in the feature branch.

It can easily be done via the PR page on the GitHub web interface, but it can
Expand All @@ -280,7 +280,7 @@ git fetch upstream
# Check out the feature branch
git checkout feature_branch
# Apply the new changes on main to your feature branch
git rebase upstream/master
git rebase upstream/main
```

In case some files have been changed on both sides you will will have to merge
Expand Down Expand Up @@ -343,7 +343,7 @@ recreate it.

```sh
# Switch to main branch
git checkout master
git checkout main
# Check local branches
git branch -vv
# Delete a specific branch
Expand Down
2 changes: 1 addition & 1 deletion content/en/about/contributing/style/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Configuration is provided in `.prettierrc`, options can be set as follow:
```

When a Pull Request is received, the proposed changes are checked using
[various linters](https://github.com/EGI-Federation/documentation/tree/master/.github/workflows).
[various linters](https://github.com/EGI-Federation/documentation/tree/main/.github/workflows).

## Adding exceptions for style violations

Expand Down

0 comments on commit 01cb4d1

Please sign in to comment.