Browse Source

SONAR-15069 Adding tooltips for github DevOps settings

tags/9.0.0.45539
Mathieu Suen 2 years ago
parent
commit
b123a8332a

+ 1
- 1
server/sonar-docs/src/pages/analysis/github-integration.md View File

@@ -86,7 +86,7 @@ Navigate to **Administration > Configuration > General Settings > ALM Integratio
- **GitHub App ID** – The App ID is found on your GitHub App's page on GitHub at **Settings > Developer Settings > GitHub Apps**.
- **Client ID** – The Client ID is found on your GitHub App's page.
- **Client secret** – The Client secret is found on your GitHub App's page.
- **Private Key** – Your GitHub App's private key. You can generate a `.pem` file from your GitHub App's page under **Private keys**. Copy and paste the contents of the file here.
- **Private Key** – Your GitHub App's private key. You can generate a `.pem` file from your GitHub App's page under **Private keys**. Copy and paste the whole contents of the file here.

## Analyzing projects with GitHub Actions
SonarScanners running in GitHub Actions can automatically detect branches and pull requests being built so you don't need to specifically pass them as parameters to the scanner.

+ 4
- 0
server/sonar-web/src/main/js/apps/settings/components/almIntegration/GithubForm.tsx View File

@@ -60,6 +60,7 @@ export default function GithubForm(props: GithubFormProps) {
value={formData.url}
/>
<AlmBindingDefinitionFormField
help={translate('settings.almintegration.form.app_id.github.help')}
id="app_id"
maxLength={80}
onFieldChange={onFieldChange}
@@ -67,6 +68,7 @@ export default function GithubForm(props: GithubFormProps) {
value={formData.appId}
/>
<AlmBindingDefinitionFormField
help={translate('settings.almintegration.form.client_id.github.help')}
id="client_id.github"
maxLength={80}
onFieldChange={onFieldChange}
@@ -74,6 +76,7 @@ export default function GithubForm(props: GithubFormProps) {
value={formData.clientId}
/>
<AlmBindingDefinitionFormField
help={translate('settings.almintegration.form.client_secret.github.help')}
id="client_secret.github"
maxLength={80}
onFieldChange={onFieldChange}
@@ -82,6 +85,7 @@ export default function GithubForm(props: GithubFormProps) {
value={formData.clientSecret}
/>
<AlmBindingDefinitionFormField
help={translate('settings.almintegration.form.private_key.github.help')}
id="private_key"
isTextArea={true}
onFieldChange={onFieldChange}

+ 8
- 0
server/sonar-web/src/main/js/apps/settings/components/almIntegration/__tests__/__snapshots__/GithubForm-test.tsx.snap View File

@@ -34,6 +34,7 @@ exports[`should render correctly 1`] = `
value=""
/>
<AlmBindingDefinitionFormField
help="settings.almintegration.form.app_id.github.help"
id="app_id"
maxLength={80}
onFieldChange={[MockFunction]}
@@ -41,6 +42,7 @@ exports[`should render correctly 1`] = `
value=""
/>
<AlmBindingDefinitionFormField
help="settings.almintegration.form.client_id.github.help"
id="client_id.github"
maxLength={80}
onFieldChange={[MockFunction]}
@@ -48,6 +50,7 @@ exports[`should render correctly 1`] = `
value=""
/>
<AlmBindingDefinitionFormField
help="settings.almintegration.form.client_secret.github.help"
id="client_secret.github"
maxLength={80}
onFieldChange={[MockFunction]}
@@ -56,6 +59,7 @@ exports[`should render correctly 1`] = `
value=""
/>
<AlmBindingDefinitionFormField
help="settings.almintegration.form.private_key.github.help"
id="private_key"
isTextArea={true}
onFieldChange={[MockFunction]}
@@ -100,6 +104,7 @@ exports[`should render correctly 2`] = `
value="http://github.enterprise.com"
/>
<AlmBindingDefinitionFormField
help="settings.almintegration.form.app_id.github.help"
id="app_id"
maxLength={80}
onFieldChange={[MockFunction]}
@@ -107,6 +112,7 @@ exports[`should render correctly 2`] = `
value="123456"
/>
<AlmBindingDefinitionFormField
help="settings.almintegration.form.client_id.github.help"
id="client_id.github"
maxLength={80}
onFieldChange={[MockFunction]}
@@ -114,6 +120,7 @@ exports[`should render correctly 2`] = `
value="client1"
/>
<AlmBindingDefinitionFormField
help="settings.almintegration.form.client_secret.github.help"
id="client_secret.github"
maxLength={80}
onFieldChange={[MockFunction]}
@@ -122,6 +129,7 @@ exports[`should render correctly 2`] = `
value="**clientsecret**"
/>
<AlmBindingDefinitionFormField
help="settings.almintegration.form.private_key.github.help"
id="private_key"
isTextArea={true}
onFieldChange={[MockFunction]}

+ 4
- 0
sonar-core/src/main/resources/org/sonar/l10n/core.properties View File

@@ -1117,6 +1117,7 @@ settings.almintegration.delete.header=Delete configuration
settings.almintegration.delete.message=Are you sure you want to delete the {id} configuration?
settings.almintegration.delete.info={0} projects will no longer get Pull Request Decorations.
settings.almintegration.delete.no_info=An unknown number of projects will no longer get Pull Request Decorations.
settings.almintegration.form.app_id.github.help=The App ID is found on your GitHub App's page on GitHub at Settings > Developer Settings > GitHub Apps
settings.almintegration.form.header.create=Create a configuration
settings.almintegration.form.header.edit=Edit the configuration
settings.almintegration.form.second_instance_warning=Binding more than one instance of an ALM will deactivate the import of repositories from that ALM.
@@ -1147,10 +1148,13 @@ settings.almintegration.form.url.gitlab=GitLab API URL
settings.almintegration.form.url.gitlab.help=Provide the GitLab API URL. For example:
settings.almintegration.form.app_id=GitHub App ID
settings.almintegration.form.client_id.github=Client ID
settings.almintegration.form.client_id.github.help=The Client ID is found on your GitHub App's page.
settings.almintegration.form.client_secret.github=Client Secret
settings.almintegration.form.client_secret.github.help=The Client secret is found on your GitHub App's page.
settings.almintegration.form.client_id.bitbucketcloud=OAuth Key
settings.almintegration.form.client_secret.bitbucketcloud=OAuth Secret
settings.almintegration.form.private_key=Private Key
settings.almintegration.form.private_key.github.help=Your GitHub App's private key. You can generate a .pem file from your GitHub App's page under Private keys. Copy and paste the whole contents of the file here.
settings.almintegration.form.personal_access_token=Personal Access token
settings.almintegration.form.personal_access_token.azure.help=Token of the user that will be used to decorate the Pull Requests. Needs authorized scope: "Code (read and write)".
settings.almintegration.form.personal_access_token.gitlab.help=Token of the user that will be used to decorate the Merge Requests. Needs API scope authorization.

Loading…
Cancel
Save