Skip to content

Commit

Permalink
Use the term 'main' where possible
Browse files Browse the repository at this point in the history
Signed-off-by: Stu Gott <[email protected]>
  • Loading branch information
stu-gott authored and fossedihelm committed Nov 18, 2021
1 parent 5f9365f commit e0be085
Show file tree
Hide file tree
Showing 14 changed files with 26 additions and 24 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ and will be assigned by Prow.
Contributors that frequently contribute to the project may ask to join the
KubeVirt organization.

Please have a look at our [membership guidelines](https://github.com/kubevirt/community/blob/master/membership_policy.md).
Please have a look at our [membership guidelines](https://github.com/kubevirt/community/blob/main/membership_policy.md).

## Projects & Communities

Expand All @@ -109,7 +109,7 @@ Please have a look at our [membership guidelines](https://github.com/kubevirt/co
* [User Guide - Kubernetes](https://kubernetes.io/docs/user-guide/)
* Details
* [Declarative Management of Kubernetes Objects Using Configuration Files - Kubernetes](https://kubernetes.io/docs/concepts/tools/kubectl/object-management-using-declarative-config/)
* [Kubernetes Architecture](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/architecture.md)
* [Kubernetes Architecture](https://github.com/kubernetes/community/blob/main/contributors/design-proposals/architecture/architecture.md)

## Additional Topics

Expand Down
2 changes: 1 addition & 1 deletion docs/devel/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ After a few moments the hostpath-provisioner pod should be running, we are now r
The Containerized Data Importer controller is a controller that watches for PVCs with a specific annotation. If that annotation is detected, it will use the 'storage.image.endpoint' URL to download the image, convert it if needed and write it to the requested PVC. One can then use the PVC to start a VM using the image in it. To deploy the CDI controller run this:

```bash
cluster-up/kubectl.sh apply -f https://raw.githubusercontent.com/kubevirt/containerized-data-importer/master/manifests/controller/cdi-controller-deployment.yaml
cluster-up/kubectl.sh apply -f https://raw.githubusercontent.com/kubevirt/containerized-data-importer/main/manifests/controller/cdi-controller-deployment.yaml
```

This will create
Expand Down
2 changes: 1 addition & 1 deletion docs/localstorage-disks.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This flow differs from standard scenario (import/upload/clone on storage with Im
Note:
`WaitForFirstConsumer` state for DataVolumes is available in CDI from v1.21.0 and toggled by a `HonorWaitForFirstConsumer` feature gate.
When the `HonorWaitForFirstConsumer` feature gate is enabled, the `CDI` is not starting any worker pods when the PVCs StorageClass binding mode is `WaitForFirstConsumer`. In such case the `CDI` puts the DataVolume in a new state `WaitForFirstConsumer`.
More in CDI docs [here](https://github.com/kubevirt/containerized-data-importer/blob/master/doc/waitforfirstconsumer-storage-handling.md).
More in CDI docs [here](https://github.com/kubevirt/containerized-data-importer/blob/main/doc/waitforfirstconsumer-storage-handling.md).

## Interaction with virtctl

Expand Down
2 changes: 1 addition & 1 deletion docs/monitoring-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ When creating a KubeVirt alert rule, please see the following :
- Warning alerts - When an alert require user intervention. A more serious issue may develop if this is not resolved soon.
- Info alerts - When a minor problem has been detected. It should be resolved relatively soon and not ignored.

5. Alert `message` must be verbose, since it is being propagated to the [metrics.md](https://github.com/kubevirt/kubevirt/blob/master/docs/monitoring-guidelines.md) file, when running `make-generate`.
5. Alert `message` must be verbose, since it is being propagated to the [metrics.md](https://github.com/kubevirt/kubevirt/blob/main/docs/monitoring-guidelines.md) file, when running `make-generate`.
4 changes: 2 additions & 2 deletions docs/quarantine.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ would lead to a terrible 41.81% passing rate of the whole suite (0.95 ** 17 = 0.

In order to remove as much as possible the influence of changes in PRs to
determine the stability of the suite, we will take into account only results
from the periodics that run e2e tests from master (hese jobs can be checked
from the periodics that run e2e tests from main (hese jobs can be checked
[on testgrid]) and presubmits that are executed on merged code (on tide merge
batches as reported by flakefinder).

Expand Down Expand Up @@ -72,7 +72,7 @@ Each quarantined test must have a team owner. The PR will add the text

When a test marked with the [release-blocker] meets the conditions to be
quarantined we will:
* Create github issue with a comment `/release-blocker master` to ensure that
* Create github issue with a comment `/release-blocker main` to ensure that
the issue is addressed before a new release is cut.
* Ensure that the github issue is assigned to an individual who will own bringing
the blocker to completion within a quick time frame.
Expand Down
8 changes: 4 additions & 4 deletions docs/release-branch-backporting.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Release Branch Backporting Policy

Bug fixes are eligible to be backported from the master branch to any previous
Bug fixes are eligible to be backported from the main branch to any previous
release branch. The following criteria must be met before a backport can be
considered. It is the reviewer's and approver's responsibility to uphold this
policy.

- **Bug Fix Only:** The backport must be a [bug fix](https://github.com/kubevirt/kubevirt/blob/master/docs/release-branch-backporting.md#bug-fix-definition) and the bug fix must be
first merged into the master branch. The only exception is when a bug only
exists in a stable branch and does not exist in the master branch.
- **Bug Fix Only:** The backport must be a [bug fix](https://github.com/kubevirt/kubevirt/blob/main/docs/release-branch-backporting.md#bug-fix-definition) and the bug fix must be
first merged into the main branch. The only exception is when a bug only
exists in a stable branch and does not exist in the main branch.

- **Release Note** The PR description's release-note section must indicate in
a brief one line statement what the backport addresses. This note gets
Expand Down
16 changes: 8 additions & 8 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@


# Overview
- Release process is automated by [hack/release.sh](https://github.com/kubevirt/kubevirt/blob/master/hack/release.sh) script
- Release process is automated by [hack/release.sh](https://github.com/kubevirt/kubevirt/blob/main/hack/release.sh) script
- KubeVirt uses [semantic versioning](http://semver.org)
- Primary artifact is the source tree in form of signed git tag
- Binary artifacts are built using automation
Expand Down Expand Up @@ -101,7 +101,7 @@ git show v0.31.0-rc.0

# Handling Release Blockers

Release blockers can be set on issues and PRs by [approvers](https://github.com/kubevirt/kubevirt/blob/master/OWNERS_ALIASES) of the project. A PR or
Release blockers can be set on issues and PRs by [approvers](https://github.com/kubevirt/kubevirt/blob/main/OWNERS_ALIASES) of the project. A PR or
issue can be flaged as a blocker through the use of the `/release-blocker <branch>`
in a github comment.

Expand All @@ -114,7 +114,7 @@ for closed issues!**

A release blocker is a critial bug, regression, or backwards incompatible change
that must be addressed before the next official release is made. Only KubeVirt
[approvers](https://github.com/kubevirt/kubevirt/blob/master/OWNERS_ALIASES) can set this label on a PR or Issue.
[approvers](https://github.com/kubevirt/kubevirt/blob/main/OWNERS_ALIASES) can set this label on a PR or Issue.

## Setting a Release Blocker

Expand All @@ -125,7 +125,7 @@ that the release blocker labels should remain even after an issue or PR is close
**Example: Signalling a PR/Issue should block the next release branch.** This
Will prevent a new release branch from being cut until PR/Issue is closed.

```/release-blocker master```
```/release-blocker main```

**Example: Signalling a PR/Issue should block the official release of a
stable branch** This will prevent any existing RCs from being promoted
Expand All @@ -140,9 +140,9 @@ isn't a blocker.

```/release-blocker cancel release-0.31```

and canceling a blocker on master would look like.
and canceling a blocker on main would look like.

```/release-blocker cancel master```
```/release-blocker cancel main```

# Creating Releases

Expand Down Expand Up @@ -272,9 +272,9 @@ For now, community members can propose pull requests to be included into a
stable branch.
Those pull requests should be limited to bug fixes and must not be
enhancements. More info related to the policy around backporting can be found
in this document, [docs/release-branch-backporting.md](https://github.com/kubevirt/kubevirt/blob/master/docs/release-branch-backporting.md)
in this document, [docs/release-branch-backporting.md](https://github.com/kubevirt/kubevirt/blob/main/docs/release-branch-backporting.md)

Cherry picking can be used to pick a merge commit from the master branch
Cherry picking can be used to pick a merge commit from the main branch
to a stable branch. An example:

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/reviewer-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Make a few passes over the code you want to review.

## Pull Request structure

* It's preferred that authors rebase on master instead of merging master into their PRs.
* It's preferred that authors rebase on main instead of merging main into their PRs.
* We merge PRs into our branches.
* Commits in a PR should make sense: Ask people to squash commits like "Fix reviewer comments", "wip", "addition", ...

Expand Down
2 changes: 1 addition & 1 deletion docs/update-go-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ In addition, [go rules for bazel](https://github.com/bazelbuild/rules_go) have t
```
* Visit [Bazel's releases page](https://github.com/bazelbuild/rules_go/releases) and check whether the current Bazel version supports the new Go version.
* If it is not supported, replace the `io_bazel_rules_go` definition with the one provided in Bazel's page.
* Use [project-infra's uploader tool](https://github.com/kubevirt/project-infra/blob/master/plugins/cmd/uploader/README.md) to upload new dependencies to dependency mirror.
* Use [project-infra's uploader tool](https://github.com/kubevirt/project-infra/blob/main/plugins/cmd/uploader/README.md) to upload new dependencies to dependency mirror.



2 changes: 1 addition & 1 deletion hack/autobump-generic.sh
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ title="Run make $@"
git commit -s -m "${title}"
git push -f "https://${user}@github.com/${user}/kubevirt.git" HEAD:autoupdate-$@

echo "Creating PR to merge ${user}:autoupdate into master..." >&2
echo "Creating PR to merge ${user}:autoupdate into main..." >&2
pr-creator \
--github-token-path="${token}" \
--org=kubevirt --repo=kubevirt --branch=main \
Expand Down
2 changes: 1 addition & 1 deletion hack/autobump-kubevirtci.sh
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ title="Run hack/bump-kubevirtci.sh, updating to ${kubevirtci_git_hash:0:8}..."
git commit -s -m "${title}"
git push -f "https://${user}@github.com/${user}/kubevirt.git" HEAD:kubevirtci

echo "Creating PR to merge ${user}:kubevirtci into master..." >&2
echo "Creating PR to merge ${user}:kubevirtci into main..." >&2
pr-creator \
--github-token-path="${token}" \
--org=kubevirt --repo=kubevirt --branch=main \
Expand Down
1 change: 1 addition & 0 deletions hack/builder/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ ENV PATH=$PATH:/opt/gradle/gradle-6.6/bin \

ENV GIMME_GO_VERSION=1.16.6

# reference to master is for an external repo and can't yet be changed
RUN mkdir -p /gimme && curl -sL \
https://raw.githubusercontent.com/travis-ci/gimme/master/gimme | \
HOME=/gimme bash >> /etc/profile.d/gimme.sh
Expand Down
2 changes: 1 addition & 1 deletion hack/gen-swagger-doc/deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Content of this repository is generated from OpenAPI specification of
## KubeVirt API References
* [master](${GITHUB_IO_FQDN}/master/index.html)
* [main](${GITHUB_IO_FQDN}/main/index.html)
__EOF__
find * -type d -regex "^v[0-9.]*" \
-exec echo "* [{}](${GITHUB_IO_FQDN}/{}/index.html)" \; | sort -r --version-sort -t '[' --key 2 >>README.md
Expand Down
1 change: 1 addition & 0 deletions hack/gen-swagger-doc/gen-swagger-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ elif [ "$OUTPUT_FORMAT" = "markdown" ]; then
# Generate TOC for definitions & operations as README.md
cd "$WORKDIR"
echo "# KubeVirt API Reference" >README.md
# reference to master is for an external repo and can't yet be changed
curl \
https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc |
bash -s "definitions.md" "operations.md" |
Expand Down

0 comments on commit e0be085

Please sign in to comment.