From 5e216710672e237ce18e43c0c8fe82faacaacd3b Mon Sep 17 00:00:00 2001 From: Wouter Admiraal Date: Thu, 26 Aug 2021 10:04:55 +0200 Subject: [PATCH] SONAR-13623 Replace "master/slave" with a better terminology --- .../pages/analysis/azuredevops-integration.md | 8 ++++---- .../analysis/bitbucket-cloud-integration.md | 8 ++++---- .../src/pages/analysis/gitlab-integration.md | 6 +++--- .../src/pages/branches/branches-faq.md | 2 +- .../sonar-docs/src/pages/branches/overview.md | 8 ++++---- .../src/pages/setup/operate-cluster.md | 2 +- .../pages/sonarcloud/integrations/github.md | 2 +- .../AnalysisCommand-test.tsx.snap | 20 +++++++++---------- .../bitbucket-pipelines/commands/CFamily.ts | 2 +- .../bitbucket-pipelines/commands/DotNet.ts | 2 +- .../bitbucket-pipelines/commands/Gradle.ts | 2 +- .../bitbucket-pipelines/commands/Maven.ts | 2 +- .../bitbucket-pipelines/commands/Others.ts | 2 +- .../github-action/commands/CFamily.tsx | 2 +- .../__snapshots__/CFamily-test.tsx.snap | 6 +++--- .../gitlabci/commands/PipeCommand.tsx | 2 +- .../__snapshots__/PipeCommand-test.tsx.snap | 16 +++++++-------- 17 files changed, 46 insertions(+), 46 deletions(-) diff --git a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md index 982b7273dc7..540e074e670 100644 --- a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md +++ b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md @@ -87,7 +87,7 @@ Select your build technology below to expand the instructions for configuring br | **.yml example**: | ``` | trigger: -| - master +| - master # or the name of your main branch | - feature/* | | steps: @@ -128,7 +128,7 @@ Select your build technology below to expand the instructions for configuring br | **.yml example**: | ``` | trigger: -| - master +| - master # or the name of your main branch | - feature/* | | steps: @@ -160,7 +160,7 @@ Select your build technology below to expand the instructions for configuring br | **.yml example**: | ``` | trigger: -| - master +| - master # or the name of your main branch | - feature/* | | steps: @@ -233,7 +233,7 @@ Select your build technology below to expand the instructions for configuring br | **.yml example**: | ``` | trigger: -| - master +| - master # or the name of your main branch | - feature/* | | steps: diff --git a/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md b/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md index 6722f4d8fb1..040e769be65 100644 --- a/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md +++ b/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md @@ -100,7 +100,7 @@ Click the scanner you're using below to expand the example configuration: | | pipelines: | branches: -| '{master,develop}': +| '{master,main,develop}': | - step: | name: SonarQube analysis | caches: @@ -139,7 +139,7 @@ Click the scanner you're using below to expand the example configuration: | | pipelines: | branches: -| '{master,develop}': +| '{master,main,develop}': | - step: | name: SonarQube analysis | caches: @@ -172,7 +172,7 @@ Click the scanner you're using below to expand the example configuration: | image: mcr.microsoft.com/dotnet/core/sdk:latest | pipelines: | branches: -| '{master}': +| '{master,main,develop}': | - step: | name: SonarQube analysis | caches: @@ -224,7 +224,7 @@ Click the scanner you're using below to expand the example configuration: | | pipelines: | branches: -| '{master,develop}': +| '{master,main,develop}': | - step: | name: SonarQube analysis | image: sonarsource/sonar-scanner-cli:latest diff --git a/server/sonar-docs/src/pages/analysis/gitlab-integration.md b/server/sonar-docs/src/pages/analysis/gitlab-integration.md index f13ccd4d78e..93646f1bc41 100644 --- a/server/sonar-docs/src/pages/analysis/gitlab-integration.md +++ b/server/sonar-docs/src/pages/analysis/gitlab-integration.md @@ -124,7 +124,7 @@ Click the scanner you're using below to expand an example configuration: | allow_failure: true | only: | - merge_requests -| - master +| - master # or the name of your main branch | - develop | ``` @@ -146,7 +146,7 @@ Click the scanner you're using below to expand an example configuration: | allow_failure: true | only: | - merge_requests -| - master +| - master # or the name of your main branch | - develop | ``` @@ -170,7 +170,7 @@ Click the scanner you're using below to expand an example configuration: | allow_failure: true | only: | - merge_requests -| - master +| - master # or the name of your main branch | - develop | ``` | diff --git a/server/sonar-docs/src/pages/branches/branches-faq.md b/server/sonar-docs/src/pages/branches/branches-faq.md index c832df0409a..f010555a7ee 100644 --- a/server/sonar-docs/src/pages/branches/branches-faq.md +++ b/server/sonar-docs/src/pages/branches/branches-faq.md @@ -12,7 +12,7 @@ Branches will be deleted automatically when they are inactive according to your No, you don't need to be connected to a SCM. However, SCM data still enhances the SonarQube experience (including issue auto-assignment and issue backdating), and you will be well prepared to take advantage of [Pull Request Analysis](/analysis/pull-request/)! ## What if I mark an Issue "Won't Fix" or "False-Positive" in a branch? -It will be replicated as such when creating a pull request and merging the pull request into the master branch. +It will be replicated as such when creating a pull request and merging the pull request into the main branch. If you're using the **Reference Branch** [New Code](/project-administration/new-code-period/) definition, issues in the reference branch that come from a feature branch automatically inherit their attributes (including "Won't Fix" and "False Positive" resolutions) from the feature branch. ## Can I manually delete a branch? diff --git a/server/sonar-docs/src/pages/branches/overview.md b/server/sonar-docs/src/pages/branches/overview.md index e44a8bb9178..e0821123b1e 100644 --- a/server/sonar-docs/src/pages/branches/overview.md +++ b/server/sonar-docs/src/pages/branches/overview.md @@ -21,7 +21,7 @@ Starting in [Developer Edition](https://redirect.sonarsource.com/editions/develo ### Settings and Quality Profiles on Branches -Branch settings and Quality Profiles are the same as those set for the master branch, and by design, it's not possible to configure other values. The New Code Period is the only exception to this as it can be set on a branch-by-branch basis. +Branch settings and Quality Profiles are the same as those set for the main branch, and by design, it's not possible to configure other values. The New Code Period is the only exception to this as it can be set on a branch-by-branch basis. ### New Code @@ -46,17 +46,17 @@ A branch is created when the `sonar.branch.name` parameter is passed during anal You need to add a condition to your pipeline script to ensure only relevant branches are analyzed. For example, you wouldn't want to run analysis on feature branches that won't need analysis until they have pull requests . -In the following example, analysis would be limited to branches named `master` or `release/*`. +In the following example, analysis would be limited to branches named `main` or `release/*`. ``` -if [[ "$CI_BRANCH_NAME" == master ]] || [[ "$CI_BRANCH_NAME" == release/* ]]; then +if [[ "$CI_BRANCH_NAME" == main ]] || [[ "$CI_BRANCH_NAME" == release/* ]]; then ./gradlew sonarqube fi ``` ### Issue Creation and Synchronization -During the first analysis, issues (type, severity, status, assignee, change log, comments) are synchronized with the Main Branch. In each synchronized issue, a comment is added to the change log of the issue on the branch: "The issue has been copied from branch 'master' to branch 'yyy'". +During the first analysis, issues (type, severity, status, assignee, change log, comments) are synchronized with the Main Branch. In each synchronized issue, a comment is added to the change log of the issue on the branch: "The issue has been copied from branch 'main' to branch 'yyy'". At each subsequent analysis of the branch, any new issue in the Main Branch that comes from a pull request automatically inherits its attributes (type, severity, ...) from the pull request. A comment is added to the change log of the issue on the branch: "The issue has been merged from 'xxx' into 'yyy'" diff --git a/server/sonar-docs/src/pages/setup/operate-cluster.md b/server/sonar-docs/src/pages/setup/operate-cluster.md index 6395a9c25e3..4d076889425 100644 --- a/server/sonar-docs/src/pages/setup/operate-cluster.md +++ b/server/sonar-docs/src/pages/setup/operate-cluster.md @@ -148,7 +148,7 @@ Property | Description | Default | Required `sonar.cluster.es.hosts`|Comma-delimited list of search hosts in the cluster. The list can contain either the host or the host and port but not both. The item format is `sonar.cluster.node.es.host` for host only or`sonar.cluster.node.es.host:sonar.cluster.node.es.port` for host and port.| |yes `sonar.cluster.node.es.host`|Elasticsearch host of the current node used by Elasticsearch internal communication to form a cluster (TCP transport).|localhost|yes `sonar.cluster.node.es.port`|Elasticsearch port of the current node used by Elasticsearch internal communication to form a cluster (TCP transport). Port must be accessible to all other search nodes|9002| yes -`sonar.search.initialStateTimeout`|The timeout for the Elasticsearch nodes to elect a master node. The default value will be fine in most cases, but in a situation where startup is failing because of a timeout, this may need to be adjusted. The value must be set in the format: `{integer}{timeunit}`. Valid `{timeunit}` values are: `ms` (milliseconds); `s` (seconds); `m` (minutes); `h` (hours); `d` (days); `w` (weeks)|cluster: 120s; standalone: 30s|no +`sonar.search.initialStateTimeout`|The timeout for the Elasticsearch nodes to elect a primary node. The default value will be fine in most cases, but in a situation where startup is failing because of a timeout, this may need to be adjusted. The value must be set in the format: `{integer}{timeunit}`. Valid `{timeunit}` values are: `ms` (milliseconds); `s` (seconds); `m` (minutes); `h` (hours); `d` (days); `w` (weeks)|cluster: 120s; standalone: 30s|no ### Elasticsearch authentication diff --git a/server/sonar-docs/src/pages/sonarcloud/integrations/github.md b/server/sonar-docs/src/pages/sonarcloud/integrations/github.md index fecd6dbc68e..a5cf72625d6 100644 --- a/server/sonar-docs/src/pages/sonarcloud/integrations/github.md +++ b/server/sonar-docs/src/pages/sonarcloud/integrations/github.md @@ -40,7 +40,7 @@ If AutoScan does not make sense yet for your repository, you need to configure y Here is an example of configuration for pull requests when you are not on Travis CI and you need to configure your CI jobs: ``` -sonar.pullrequest.base=master +sonar.pullrequest.base=main sonar.pullrequest.branch=feature/my-new-feature sonar.pullrequest.key=5 sonar.pullrequest.provider=GitHub diff --git a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/__tests__/__snapshots__/AnalysisCommand-test.tsx.snap b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/__tests__/__snapshots__/AnalysisCommand-test.tsx.snap index fee8cfa96ea..b095418e2c5 100644 --- a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/__tests__/__snapshots__/AnalysisCommand-test.tsx.snap +++ b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/__tests__/__snapshots__/AnalysisCommand-test.tsx.snap @@ -36,7 +36,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: Download and install the build wrapper, build the project script: @@ -96,7 +96,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: Download and install the build wrapper, build the project script: @@ -167,7 +167,7 @@ exports[`should render correctly for dotnet 1`] = ` pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis caches: @@ -222,7 +222,7 @@ exports[`should render correctly for dotnet: with branch enabled 1`] = ` pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis caches: @@ -296,7 +296,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis caches: @@ -348,7 +348,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis caches: @@ -410,7 +410,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis caches: @@ -462,7 +462,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis caches: @@ -524,7 +524,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis script: @@ -576,7 +576,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis script: diff --git a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/CFamily.ts b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/CFamily.ts index 87f30846c4e..bea52d0f861 100644 --- a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/CFamily.ts +++ b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/CFamily.ts @@ -26,7 +26,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: Download and install the build wrapper, build the project script: diff --git a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/DotNet.ts b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/DotNet.ts index ec1c82fdd11..1cda1d0a7fd 100644 --- a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/DotNet.ts +++ b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/DotNet.ts @@ -23,7 +23,7 @@ export default function dotNetExample(branchesEnabled: boolean, projectKey: stri pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis caches: diff --git a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Gradle.ts b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Gradle.ts index 78d5bc4c86b..35afb573797 100644 --- a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Gradle.ts +++ b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Gradle.ts @@ -26,7 +26,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis caches: diff --git a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Maven.ts b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Maven.ts index 7cc04a84a06..3ed6af9ad1b 100644 --- a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Maven.ts +++ b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Maven.ts @@ -26,7 +26,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis caches: diff --git a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Others.ts b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Others.ts index b3e147b98d6..d06403f8b8c 100644 --- a/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Others.ts +++ b/server/sonar-web/src/main/js/components/tutorials/bitbucket-pipelines/commands/Others.ts @@ -26,7 +26,7 @@ clone: pipelines: branches: - '{master}': + '{master}': # or the name of your main branch - step: name: SonarQube analysis script: diff --git a/server/sonar-web/src/main/js/components/tutorials/github-action/commands/CFamily.tsx b/server/sonar-web/src/main/js/components/tutorials/github-action/commands/CFamily.tsx index a75146f9f2b..e10317533f4 100644 --- a/server/sonar-web/src/main/js/components/tutorials/github-action/commands/CFamily.tsx +++ b/server/sonar-web/src/main/js/components/tutorials/github-action/commands/CFamily.tsx @@ -124,7 +124,7 @@ const cfamilyYamlTemplate = (branchesEnabled: boolean, os: OSs) => `name: Build on: push: branches: - - master + - master # or the name of your main branch ${branchesEnabled ? ' pull_request:\n types: [opened, synchronize, reopened]' : ''} jobs: diff --git a/server/sonar-web/src/main/js/components/tutorials/github-action/commands/__tests__/__snapshots__/CFamily-test.tsx.snap b/server/sonar-web/src/main/js/components/tutorials/github-action/commands/__tests__/__snapshots__/CFamily-test.tsx.snap index 964c6787a55..38c323434e5 100644 --- a/server/sonar-web/src/main/js/components/tutorials/github-action/commands/__tests__/__snapshots__/CFamily-test.tsx.snap +++ b/server/sonar-web/src/main/js/components/tutorials/github-action/commands/__tests__/__snapshots__/CFamily-test.tsx.snap @@ -96,7 +96,7 @@ exports[`should render correctly for linux: branches disabled 1`] = ` on: push: branches: - - master + - master # or the name of your main branch jobs: @@ -185,7 +185,7 @@ exports[`should render correctly for mac: branches enabled 1`] = ` on: push: branches: - - master + - master # or the name of your main branch pull_request: types: [opened, synchronize, reopened] @@ -280,7 +280,7 @@ exports[`should render correctly for win: branches enabled 1`] = ` on: push: branches: - - master + - master # or the name of your main branch pull_request: types: [opened, synchronize, reopened] diff --git a/server/sonar-web/src/main/js/components/tutorials/gitlabci/commands/PipeCommand.tsx b/server/sonar-web/src/main/js/components/tutorials/gitlabci/commands/PipeCommand.tsx index e4113bd8e54..282bdb14dea 100644 --- a/server/sonar-web/src/main/js/components/tutorials/gitlabci/commands/PipeCommand.tsx +++ b/server/sonar-web/src/main/js/components/tutorials/gitlabci/commands/PipeCommand.tsx @@ -91,7 +91,7 @@ sonarqube-check: } else { const onlyBlock = branchesEnabled ? `- merge_requests - - master + - master # or the name of your main branch - develop` : '- master # or the name of your main branch'; diff --git a/server/sonar-web/src/main/js/components/tutorials/gitlabci/commands/__tests__/__snapshots__/PipeCommand-test.tsx.snap b/server/sonar-web/src/main/js/components/tutorials/gitlabci/commands/__tests__/__snapshots__/PipeCommand-test.tsx.snap index 4be8e72f3d8..e27d0b983b0 100644 --- a/server/sonar-web/src/main/js/components/tutorials/gitlabci/commands/__tests__/__snapshots__/PipeCommand-test.tsx.snap +++ b/server/sonar-web/src/main/js/components/tutorials/gitlabci/commands/__tests__/__snapshots__/PipeCommand-test.tsx.snap @@ -99,7 +99,7 @@ exports[`should render correctly for dotnet: branches enabled 1`] = ` allow_failure: true only: - merge_requests - - master + - master # or the name of your main branch - develop " /> @@ -129,7 +129,7 @@ exports[`should render correctly for dotnet: branches not enabled 1`] = ` allow_failure: true only: - merge_requests - - master + - master # or the name of your main branch - develop " /> @@ -152,7 +152,7 @@ exports[`should render correctly for gradle: branches enabled 1`] = ` allow_failure: true only: - merge_requests - - master + - master # or the name of your main branch - develop " /> @@ -175,7 +175,7 @@ exports[`should render correctly for gradle: branches not enabled 1`] = ` allow_failure: true only: - merge_requests - - master + - master # or the name of your main branch - develop " /> @@ -199,7 +199,7 @@ exports[`should render correctly for maven: branches enabled 1`] = ` allow_failure: true only: - merge_requests - - master + - master # or the name of your main branch - develop " /> @@ -223,7 +223,7 @@ exports[`should render correctly for maven: branches not enabled 1`] = ` allow_failure: true only: - merge_requests - - master + - master # or the name of your main branch - develop " /> @@ -249,7 +249,7 @@ exports[`should render correctly for other: branches enabled 1`] = ` allow_failure: true only: - merge_requests - - master + - master # or the name of your main branch - develop " /> @@ -275,7 +275,7 @@ exports[`should render correctly for other: branches not enabled 1`] = ` allow_failure: true only: - merge_requests - - master + - master # or the name of your main branch - develop " /> -- 2.39.5