Prepare the Strimzi Operators repo to rename the master branch to main (strimzi#4636)

* Prepare the Strimzi Operators repo to rename the master branch to main

Signed-off-by: Jakub Scholz <[email protected]>

* Fix the contributing guide

Signed-off-by: Jakub Scholz <[email protected]>

* Fix Helm Charts

Signed-off-by: Jakub Scholz <[email protected]>

Author: scholzj

.azure/build-pipeline.yaml

@@ -2,7 +2,7 @@
 trigger:
   branches:
     include:
-      - 'master'
+      - 'main'
       - 'release-*'
   tags:
     include:

.azure/scripts/build.sh

@@ -60,18 +60,18 @@ fi
 # Push artifatcs (Docker containers, JARs, docs)
 if [ "$BUILD_REASON" == "PullRequest" ] ; then
     echo "Building Pull Request - nothing to push"
-elif [[ "$BRANCH" != "refs/tags/"* ]] && [ "$BRANCH" != "refs/heads/master" ]; then
-    echo "Not in master branch and not in release tag - nothing to push"
+elif [[ "$BRANCH" != "refs/tags/"* ]] && [ "$BRANCH" != "refs/heads/main" ]; then
+    echo "Not in main branch and not in release tag - nothing to push"
 else
     if [ "${MAIN_BUILD}" == "TRUE" ] ; then
-        echo "Main build on master branch or release tag - going to push to Docker Hub, Nexus and website"
+        echo "Main build on main branch or release tag - going to push to Docker Hub, Nexus and website"
 
         echo "Login into Docker Hub ..."
         docker login -u $DOCKER_USER -p $DOCKER_PASS $DOCKER_REGISTRY
 
         export DOCKER_ORG=strimzi
 
-        if [ "$BRANCH" == "refs/heads/master" ]; then
+        if [ "$BRANCH" == "refs/heads/main" ]; then
             export DOCKER_TAG="latest"
         else
             export DOCKER_TAG="${BRANCH#refs/tags/}"
@@ -80,7 +80,7 @@ else
         echo "Pushing to docker org $DOCKER_ORG"
         make docker_push
 
-        if [ "$BRANCH" == "refs/heads/master" ]; then
+        if [ "$BRANCH" == "refs/heads/main" ]; then
             make docu_pushtowebsite
         fi
 

.azure/scripts/docu-push-to-website.sh

@@ -33,6 +33,6 @@ git config user.email "[email protected]"
 
 git add -A
 git commit -s -m "Update documentation (Travis CI build ${TRAVIS_BUILD_NUMBER})" --allow-empty
-git push origin master
+git push origin main
 
 popd

.azure/templates/default_variables.yaml

@@ -1,12 +1,12 @@
 # Default variables for jobs
 variables:
-  ${{ if eq( variables['Build.SourceBranch'], 'refs/heads/master' ) }}:
+  ${{ if eq( variables['Build.SourceBranch'], 'refs/heads/main' ) }}:
     pull_request: false
     docker_org: strimzi
     docker_registry: quay.io
     tag: latest
     commit: latest
-  ${{ if ne( variables['Build.SourceBranch'], 'refs/heads/master' ) }}:
+  ${{ if ne( variables['Build.SourceBranch'], 'refs/heads/main' ) }}:
     ${{ if startsWith( variables['Build.SourceBranch'], 'refs/tags/' ) }}:
       pull_request: false
       docker_org: strimzi

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
 # Strimzi Community Code of Conduct
 
-Strimzi Community Code of Conduct is defined in the [governance repository](https://github.com/strimzi/governance/blob/master/CODE_OF_CONDUCT.md).
+Strimzi Community Code of Conduct is defined in the [governance repository](https://github.com/strimzi/governance/blob/main/CODE_OF_CONDUCT.md).

CONTRIBUTING.md

@@ -30,7 +30,7 @@ If you want to get in touch with us first before contributing, you can use:
 
 # How to become a maintainer
 
-The governance of the project is defined in the [GOVERNANCE.md](https://github.com/strimzi/strimzi-kafka-operator/blob/master/GOVERNANCE.md) file in the Strimzi Github repository, but in summary certain members of the community are the "maintainers" who decide the direction of the project. New maintainers can be elected by a ⅔ majority vote of the existing maintainers.
+The governance of the project is defined in the [GOVERNANCE.md](https://github.com/strimzi/strimzi-kafka-operator/blob/main/GOVERNANCE.md) file in the Strimzi Github repository, but in summary certain members of the community are the "maintainers" who decide the direction of the project. New maintainers can be elected by a ⅔ majority vote of the existing maintainers.
 
 So as to be transparent and to ensure that all potential maintainers are judged fairly and consistently the following criteria should be taken into account in electing new maintainers:
 

Makefile

@@ -2,7 +2,7 @@ TOPDIR=$(dir $(lastword $(MAKEFILE_LIST)))
 
 include ./Makefile.os
 
-GITHUB_VERSION ?= master
+GITHUB_VERSION ?= main
 RELEASE_VERSION ?= latest
 CHART_SEMANTIC_RELEASE_VERSION ?= $(shell cat ./release.version | tr A-Z a-z)
 BRIDGE_VERSION ?= $(shell cat ./bridge.version | tr A-Z a-z)

README.md

@@ -2,7 +2,7 @@
 
 # Run Apache Kafka on Kubernetes and OpenShift
 
-[![Build Status](https://dev.azure.com/cncf/strimzi/_apis/build/status/build?branchName=master)](https://dev.azure.com/cncf/strimzi/_build/latest?definitionId=16&branchName=master)
+[![Build Status](https://dev.azure.com/cncf/strimzi/_apis/build/status/build?branchName=main)](https://dev.azure.com/cncf/strimzi/_build/latest?definitionId=16&branchName=main)
 [![GitHub release](https://img.shields.io/github/release/strimzi/strimzi-kafka-operator.svg)](https://github.com/strimzi/strimzi-kafka-operator/releases/latest)
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 [![Twitter Follow](https://img.shields.io/twitter/follow/strimziio.svg?style=social&label=Follow&style=for-the-badge)](https://twitter.com/strimziio)
@@ -17,7 +17,7 @@ To get up and running quickly, check our [Quick Start for Minikube, OKD (OpenShi
 
 ## Documentation
 
-Documentation to the current _master_ branch as well as all releases can be found on our [website][strimzi].
+Documentation to the current _main_ branch as well as all releases can be found on our [website][strimzi].
 
 ## Getting help
 
@@ -50,8 +50,8 @@ All bugs, tasks or enhancements are tracked as [GitHub issues](https://github.co
 might be a good start for new contributors are marked with ["good-start"](https://github.com/strimzi/strimzi-kafka-operator/labels/good-start)
 label.
 
-The [Dev guide](https://github.com/strimzi/strimzi-kafka-operator/blob/master/development-docs/DEV_GUIDE.md) describes how to build Strimzi.
-Before submitting a patch, please make sure to understand, how to test your changes before opening a PR [Test guide](https://github.com/strimzi/strimzi-kafka-operator/blob/master/development-docs/TESTING.md).
+The [Dev guide](https://github.com/strimzi/strimzi-kafka-operator/blob/main/development-docs/DEV_GUIDE.md) describes how to build Strimzi.
+Before submitting a patch, please make sure to understand, how to test your changes before opening a PR [Test guide](https://github.com/strimzi/strimzi-kafka-operator/blob/main/development-docs/TESTING.md).
 
 The [Documentation Contributor Guide](https://strimzi.io/contributing/guide/) describes how to contribute to Strimzi documentation.
 

development-docs/DEV_GUIDE.md

@@ -173,7 +173,7 @@ Other build options:
 
 ### Kafka versions
 
-As part of the Docker image build several different versions of Kafka will be built, which can increase build times. Which Kafka versions are to be built are defined in the [kafka-versions.yaml](https://github.com/strimzi/strimzi-kafka-operator/blob/master/kafka-versions.yaml) file. Unwanted versions can be commented out to speed up the build process. 
+As part of the Docker image build several different versions of Kafka will be built, which can increase build times. Which Kafka versions are to be built are defined in the [kafka-versions.yaml](https://github.com/strimzi/strimzi-kafka-operator/blob/main/kafka-versions.yaml) file. Unwanted versions can be commented out to speed up the build process. 
 
 ### Maven Settings
 

development-docs/RELEASE.md

@@ -11,7 +11,7 @@ The `release` target will not build the Docker images - they should be built and
 The release process should normally look like this:
 
 1. Create a release branch
-2. On the `master` git branch of the operators repository:
+2. On the `main` git branch of the operators repository:
   * Update the versions to the next SNAPSHOT version using the `next_version` `make` target. For example to update the next version to `0.6.0-SNAPSHOT` run: `make NEXT_VERSION=0.6.0-SNAPSHOT next_version`.
 
 3. Run `make clean`
@@ -35,21 +35,20 @@ The release process should normally look like this:
     * Copy files from the operators repository `documentation/html` to `docs/operators/latest/full` in the website repository
   * Update the Helm Chart repository file by copying `helm-charts/helm3/index.yaml` in the operators GitHub repository to `charts/index.yaml` in the website GitHub repsoitory.
 
-12. _(only for GA, not for RCs)_ The maven artifacts (`api` module) will be automatically staged from Azure during the tag build. It has to be releases from [Sonatype](https://oss.sonatype.org/#stagingRepositories) to get to the main Maven repositories.
-13. _(only for GA, not for RCs)_ On the `master` git branch of the operators repository:
-  * Copy the `packaging/helm-charts/index.yaml` from the `release` branch to `master`
+12. _(only for GA, not for RCs)_ On the `main` git branch of the operators repository:
+  * Copy the `packaging/helm-charts/index.yaml` from the `release` branch to `main`
   * Update the `ProductVersion` variable in `documentation/using/shared/attributes.doc`
-  * Update the `install`, `examples` and `helm-chart` directories in the `master` branch with the newly released files
+  * Update the `install`, `examples` and `helm-chart` directories in the `main` branch with the newly released files
 
+13. _(only for GA, not for RCs)_ The maven artifacts (`api` module) will be automatically staged from Azure during the tag build. It has to be releases from [Sonatype](https://oss.sonatype.org/#stagingRepositories) to get to the main Maven repositories.
 14. _(only for GA, not for RCs)_ Update the Strimzi manifest files in Operator Hub [community operators](https://github.com/operator-framework/community-operators) repository and submit a pull request upstream. *Note*: Instructions for this step need updating.
 15. _(only for GA, not for RCs)_ Add the new version to the `systemtest/src/test/resources/upgrade/StrimziUpgradeST.json` file for the upgrade tests
 16. _(only for GA, not for RCs)_ Add the new version to the `systemtest/src/test/resources/upgrade/StrimziDowngradeST.json` file and remove the old one for the downgrade tests
 
-
 ## Updating Kafka Bridge version
 
 The version of Strimzi Kafka Bridge is defined in the file `./bridge.version`.
-Even the master branch is using this fixed version and not the version build from the `master` branch of Kafka Bridge.
+Even the `main` branch is using this fixed version and not the version build from the `main` branch of Kafka Bridge.
 If you need to update the Kafka bridge to newer version, you should do it with following steps:
 
 1. Edit the `bridge.version` file and update it to contain the new Bridge version

documentation/contributing/contributor-guide.adoc

@@ -18,18 +18,18 @@ Once you have your local repository set up and have up to date copies of upstrea
 .Procedure
 . Open your terminal
 . `cd` to the directory where your documentation resides
-. Checkout the master branch
+. Checkout the main branch
 +
 [source]
 ----
-$ git checkout master
+$ git checkout main
 ----
 . Update your local repository and fork with the upstream content
 +
 [source]
 ----
-$ git pull upstream master
-$ git push origin master --force
+$ git pull upstream main
+$ git push origin main --force
 ----
 . Create a new branch for your work (using the issue number is helpful)
 +
@@ -67,7 +67,7 @@ $ git push origin HEAD
 +
 [source]
 ----
-$ git pull upstream master
+$ git pull upstream main
 $ git push -f origin HEAD
 ----
 . Visit your fork on GitHub

documentation/contributing/git-tips.adoc

@@ -7,15 +7,15 @@ To delete all of your branches except the branch you are on:
 
 [source]
 ----
-$ git checkout master
+$ git checkout main
 $ for br in `git branch` ; do git branch -D $br ; done
 ----
 
 To delete one branch:
 
 [source,options="nowrap",subs="+quotes"]
 ----
-$ git checkout master
+$ git checkout main
 $ git branch -D <branch-name>
 ----
 
@@ -27,7 +27,7 @@ To resolve a merge conflict in an existing pull request:
 ----
 $ git checkout <branch-name>
 $ git branch -u origin <branch-name>
-$ git pull --rebase upstream master
+$ git pull --rebase upstream main
 $ git push -f origin HEAD
 ----
 
@@ -37,11 +37,11 @@ If your fork is both ahead of and behind the origin you can reset your fork to m
 
 [source]
 ----
-$ git checkout master
-$ git reset --hard upstream/master
-$ git push origin master --force
-$ git pull upstream master
-$ git push origin master --force
+$ git checkout main
+$ git reset --hard upstream/main
+$ git push origin main --force
+$ git pull upstream main
+$ git push origin main --force
 ----
 
 == Using `ssh-agent` to save your SSH key's passphrase
@@ -52,7 +52,7 @@ Before using the `ssh-agent` you will see a prompt to enter your passphrase afte
 
 [source]
 ----
-[amq-repo]$ git pull --rebase upstream master
+[amq-repo]$ git pull --rebase upstream main
 Enter passphrase for key '/home/<username>/.ssh/id_rsa':
 ----
 
@@ -75,12 +75,12 @@ Identity added: /home/<username>/.ssh/id_rsa (/home/<username>/.ssh/id_rsa)
 
 This is the process you can use if you need commits another writer has submitted in a merge request that is not yet merged.
 
-. Check out a new topic branch from upstream/master as you normally do.
+. Check out a new topic branch from upstream/main as you normally do.
 +
 [source,options="nowrap",subs="+quotes"]
 ----
 $ git fetch upstream
-$ git checkout -b <new-topic-branch> upstream/master
+$ git checkout -b <new-topic-branch> upstream/main
 ----
 . If you have not yet added that writer’s remote repository, add it now.
 +

documentation/contributing/introduction.adoc

@@ -27,7 +27,7 @@ https://github.com/strimzi/strimzi-kafka-operator[`strimzi-kafka-operator`^] (Gi
 https://github.com/strimzi/strimzi-kafka-bridge[`strimzi-kafka-bridge`^] (GitHub):: The public GitHub repo hosts all of the Strimzi Kafka Bridge code.
 https://github.com/strimzi/strimzi-kafka-oauth[`strimzi-kafka-oauth`^] (GitHub):: The public GitHub repo hosts all of the Strimzi OAuth 2.0 code.
 
-The main documentation is in the Strimzi Operators repository, in the https://github.com/strimzi/strimzi-kafka-operator/tree/master/documentation[`documentation` folder^].
+The main documentation is in the Strimzi Operators repository, in the https://github.com/strimzi/strimzi-kafka-operator/tree/main/documentation[`documentation` folder^].
 The _documentation_ folder is split into _category_ folders to manage the content.
 
 Documentation category folders contain files related to Strimzi guides (Deploying, Quickstart, Overview, Using), and the files that provide the content for one or more of these guides – _assemblies_ and _modules_.

documentation/contributing/make-tooling.adoc

@@ -1,7 +1,7 @@
 [[make-tooling]]
 = Using make with documentation
 
-When you make changes to the documentation, it is a good practice to do a local test build to verify the book builds successfully and renders as you expect before you submit the merge request back to upstream master.
+When you make changes to the documentation, it is a good practice to do a local test build to verify the book builds successfully and renders as you expect before you submit the merge request back to upstream main.
 
 Make is a useful tool for building your documentation and pushing it to a public website so that peer and quality reviewers can see your edits as the user would.
 

helm-charts/helm3/strimzi-kafka-operator/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: 0.22.1
 description: 'Strimzi: Apache Kafka running on Kubernetes'
 home: https://strimzi.io/
-icon: https://raw.githubusercontent.com/strimzi/strimzi-kafka-operator/master/documentation/logo/strimzi_logo.png
+icon: https://raw.githubusercontent.com/strimzi/strimzi-kafka-operator/main/documentation/logo/strimzi_logo.png
 keywords:
 - kafka
 - queue

helm-charts/helm3/strimzi-kafka-operator/README.md

@@ -39,7 +39,7 @@ If you encounter any issues while using Strimzi, you can get help using:
 
 ### License
 
-Strimzi is licensed under the [Apache License, Version 2.0](https://github.com/strimzi/strimzi-kafka-operator/blob/master/LICENSE).
+Strimzi is licensed under the [Apache License, Version 2.0](https://github.com/strimzi/strimzi-kafka-operator/blob/main/LICENSE).
 
 ## Prerequisites
 

packaging/helm-charts/helm3/strimzi-kafka-operator/Chart.yaml

@@ -3,7 +3,7 @@ appVersion: "0.1.0"
 description: "Strimzi: Apache Kafka running on Kubernetes"
 name: strimzi-kafka-operator
 version: 0.1.0
-icon: https://raw.githubusercontent.com/strimzi/strimzi-kafka-operator/master/documentation/logo/strimzi_logo.png
+icon: https://raw.githubusercontent.com/strimzi/strimzi-kafka-operator/main/documentation/logo/strimzi_logo.png
 keywords:
 - kafka
 - queue

packaging/helm-charts/helm3/strimzi-kafka-operator/README.md

@@ -39,7 +39,7 @@ If you encounter any issues while using Strimzi, you can get help using:
 
 ### License
 
-Strimzi is licensed under the [Apache License, Version 2.0](https://github.com/strimzi/strimzi-kafka-operator/blob/master/LICENSE).
+Strimzi is licensed under the [Apache License, Version 2.0](https://github.com/strimzi/strimzi-kafka-operator/blob/main/LICENSE).
 
 ## Prerequisites