1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*
* SonarQube
* Copyright (C) 2009-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import { AlmKeys } from '../types/alm-settings';
export const DOC_URL = 'https://docs.sonarsource.com/sonarqube/latest';
export enum DocLink {
AccountTokens = '/user-guide/managing-tokens/',
ActiveVersions = '/server-upgrade-and-maintenance/upgrade/upgrade-the-server/active-versions/',
AiCodeAssurance = '/user-guide/ai-features/',
AlmAzureIntegration = '/devops-platform-integration/azure-devops-integration/',
AlmBitBucketCloudAuth = '/instance-administration/authentication/bitbucket-cloud/',
AlmBitBucketCloudIntegration = '/devops-platform-integration/bitbucket-integration/bitbucket-cloud-integration/',
AlmBitBucketCloudSettings = '/instance-administration/authentication/bitbucket-cloud/#setting-your-authentication-settings-in-sonarqube',
AlmBitBucketServerIntegration = '/devops-platform-integration/bitbucket-integration/bitbucket-server-integration/',
AlmGitHubAuth = '/instance-administration/authentication/github/',
AlmGitHubIntegration = '/devops-platform-integration/github-integration/introduction/',
AlmGitHubMonorepoWorkfileExample = '/devops-platform-integration/github-integration/adding-analysis-to-github-actions-workflow/#configuring-the-buildyml-file',
AlmGitLabAuth = '/instance-administration/authentication/gitlab/setting-up/',
AlmGitLabAuthJITProvisioningMethod = '/instance-administration/authentication/gitlab/provisioning-modes/just-in-time/',
AlmGitLabAuthAutoProvisioningMethod = '/instance-administration/authentication/gitlab/provisioning-modes/automatic/',
AlmGitLabIntegration = '/devops-platform-integration/gitlab-integration/introduction/',
AlmSamlAuth = '/instance-administration/authentication/saml/overview/',
AlmSamlScimAuth = '/instance-administration/authentication/saml/scim/overview/',
AnalysisScope = '/project-administration/analysis-scope/',
AuthOverview = '/instance-administration/authentication/overview/',
BackgroundTasks = '/analyzing-source-code/background-tasks/',
BranchAnalysis = '/analyzing-source-code/branch-analysis/introduction/',
CaYC = '/user-guide/clean-as-you-code/',
CFamilyBuildWrapper = '/analyzing-source-code/languages/c-family/prerequisites/#using-buildwrapper',
CFamilyCompilationDatabase = '/analyzing-source-code/languages/c-family/prerequisites/#using-thirdparty-tools',
CIAnalysisSetup = '/analyzing-source-code/ci-integration/overview/',
CIJenkins = '/analyzing-source-code/ci-integration/jenkins-integration/key-features/',
CleanCodeIntroduction = '/user-guide/clean-code/introduction/',
CodeAnalysis = '/user-guide/clean-code/code-analysis/',
InactiveBranches = '/project-administration/maintaining-the-branches-of-your-project/#manage-inactive-branches',
InstanceAdminEncryption = '/instance-administration/system-functions/security/#settings-encryption',
InstanceAdminLicense = '/instance-administration/license-administration/',
InstanceAdminLoC = '/server-upgrade-and-maintenance/monitoring/lines-of-code/',
InstanceAdminMarketplace = '/server-upgrade-and-maintenance/upgrade/marketplace/',
InstanceAdminPluginVersionMatrix = '/setup-and-upgrade/plugins/plugin-version-matrix/',
InstanceAdminQualityProfiles = '/instance-administration/analysis-functions/quality-profiles/',
InstanceAdminQualityProfilesPrioritizingRules = '/instance-administration/analysis-functions/quality-profiles/#prioritizing-rules',
InstanceAdminReindexation = '/server-upgrade-and-maintenance/maintenance/reindexing/',
InstanceAdminSecurity = '/instance-administration/system-functions/security/',
IssueResolutions = '/user-guide/issues/solution-overview/#deprecated-features',
Issues = '/user-guide/issues/introduction/',
IssueStatuses = '/user-guide/issues/solution-overview/#life-cycle',
MainBranchAnalysis = '/project-administration/maintaining-the-branches-of-your-project/',
ManagingPortfolios = '/project-administration/managing-portfolios/',
MetricDefinitions = '/user-guide/code-metrics/metrics-definition/',
ModeMQR = '/instance-administration/analysis-functions/instance-mode/mqr-mode',
ModeStandard = '/instance-administration/analysis-functions/instance-mode/standard-experience',
Monorepos = '/project-administration/monorepos/',
NewCodeDefinition = '/project-administration/clean-as-you-code-settings/defining-new-code/',
NewCodeDefinitionOptions = '/project-administration/clean-as-you-code-settings/defining-new-code/#new-code-definition-options',
Portfolios = '/user-guide/viewing-reports/portfolios/',
PullRequestAnalysis = '/analyzing-source-code/pull-request-analysis/introduction/',
QualityGates = '/instance-administration/analysis-functions/quality-gates/',
Root = '/',
RuleSeverity = '/instance-administration/analysis-functions/quality-profiles/#rule-severity',
RulesOverview = '/user-guide/rules/overview',
SecurityHotspots = '/user-guide/security-hotspots/',
SecurityReports = '/user-guide/viewing-reports/security-reports/',
ServerUpgradeRoadmap = '/server-upgrade-and-maintenance/upgrade/upgrade-the-server/roadmap/',
SonarLintConnectedMode = '/user-guide/sonarlint-connected-mode/',
SonarScanner = '/analyzing-source-code/scanners/sonarscanner/',
SonarScannerRequirements = '/analyzing-source-code/scanners/scanner-environment/general-requirements/',
SonarScannerDotNet = '/analyzing-source-code/scanners/dotnet/introduction/',
SonarScannerGradle = '/analyzing-source-code/scanners/sonarscanner-for-gradle/',
SonarScannerMaven = '/analyzing-source-code/scanners/sonarscanner-for-maven/',
SonarWayQualityGate = '/user-guide/quality-gates/#using-sonar-way-the-recommended-quality-gate', // to be confirmed
Webhooks = '/project-administration/webhooks/',
Dependencies = '/project-administration/managing-dependencies/',
}
export const DocTitle = {
[DocLink.BackgroundTasks]: 'About Background Tasks',
[DocLink.CaYC]: 'Clean as You Code',
[DocLink.CIAnalysisSetup]: 'Set up CI analysis',
[DocLink.InstanceAdminQualityProfiles]: 'About Quality Profiles',
[DocLink.MetricDefinitions]: 'Metric Definitions',
[DocLink.NewCodeDefinition]: 'Defining New Code',
[DocLink.PullRequestAnalysis]: 'Analyzing Pull Requests',
[DocLink.SecurityReports]: 'About Security Reports',
[DocLink.SonarLintConnectedMode]: 'SonarLint Connected Mode',
[DocLink.Webhooks]: 'About Webhooks',
};
export type DocTitleKey = keyof typeof DocTitle;
const asDocSections = <T>(element: { [K in keyof T]: DocTitleKey[] }) => element;
export const DocSection = asDocSections({
component_measures: [DocLink.CaYC, DocLink.MetricDefinitions],
overview: [
DocLink.PullRequestAnalysis,
DocLink.CIAnalysisSetup,
DocLink.CaYC,
DocLink.SonarLintConnectedMode,
],
pull_requests: [DocLink.CaYC, DocLink.PullRequestAnalysis, DocLink.SonarLintConnectedMode],
});
export type DocSectionKey = keyof typeof DocSection;
export const AlmAuthDocLinkKeys = {
[AlmKeys.BitbucketServer]: DocLink.AlmBitBucketCloudAuth,
[AlmKeys.GitHub]: DocLink.AlmGitHubAuth,
[AlmKeys.GitLab]: DocLink.AlmGitLabAuth,
saml: DocLink.AlmSamlAuth,
};
|
