diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07a7717da3ea..8f07c8979f5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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 diff --git a/docs/devel/storage.md b/docs/devel/storage.md index 0aa178285c37..0b66603f58ce 100644 --- a/docs/devel/storage.md +++ b/docs/devel/storage.md @@ -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 diff --git a/docs/localstorage-disks.md b/docs/localstorage-disks.md index d1da8bff29bc..3e5690d35221 100644 --- a/docs/localstorage-disks.md +++ b/docs/localstorage-disks.md @@ -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 diff --git a/docs/monitoring-guidelines.md b/docs/monitoring-guidelines.md index 2cc15b7ef9e3..c33665b095d9 100644 --- a/docs/monitoring-guidelines.md +++ b/docs/monitoring-guidelines.md @@ -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`. \ No newline at end of file +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`. diff --git a/docs/quarantine.md b/docs/quarantine.md index b3c702bb6d2e..849d486499cb 100644 --- a/docs/quarantine.md +++ b/docs/quarantine.md @@ -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). @@ -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. diff --git a/docs/release-branch-backporting.md b/docs/release-branch-backporting.md index 4e2045a50350..772b93a69410 100644 --- a/docs/release-branch-backporting.md +++ b/docs/release-branch-backporting.md @@ -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 diff --git a/docs/release.md b/docs/release.md index a118d5b2fd35..2d2803aaab16 100644 --- a/docs/release.md +++ b/docs/release.md @@ -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 @@ -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 ` in a github comment. @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/docs/reviewer-guide.md b/docs/reviewer-guide.md index 95ccf1fec6b8..d7988ae28eb4 100644 --- a/docs/reviewer-guide.md +++ b/docs/reviewer-guide.md @@ -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", ... diff --git a/docs/update-go-version.md b/docs/update-go-version.md index ce4d93d729e5..3e4932390b9a 100644 --- a/docs/update-go-version.md +++ b/docs/update-go-version.md @@ -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. diff --git a/hack/autobump-generic.sh b/hack/autobump-generic.sh index 3018a78759cb..4703129f16d3 100755 --- a/hack/autobump-generic.sh +++ b/hack/autobump-generic.sh @@ -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 \ diff --git a/hack/autobump-kubevirtci.sh b/hack/autobump-kubevirtci.sh index cd5405419106..3ff0b936fd8c 100755 --- a/hack/autobump-kubevirtci.sh +++ b/hack/autobump-kubevirtci.sh @@ -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 \ diff --git a/hack/builder/Dockerfile b/hack/builder/Dockerfile index cfcb49d19db5..7acc10f3b031 100644 --- a/hack/builder/Dockerfile +++ b/hack/builder/Dockerfile @@ -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 diff --git a/hack/gen-swagger-doc/deploy.sh b/hack/gen-swagger-doc/deploy.sh index 4f5abcca4828..a28f29b5e323 100755 --- a/hack/gen-swagger-doc/deploy.sh +++ b/hack/gen-swagger-doc/deploy.sh @@ -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 diff --git a/hack/gen-swagger-doc/gen-swagger-docs.sh b/hack/gen-swagger-doc/gen-swagger-docs.sh index 9333e2577dad..8be1518d999b 100755 --- a/hack/gen-swagger-doc/gen-swagger-docs.sh +++ b/hack/gen-swagger-doc/gen-swagger-docs.sh @@ -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" |