You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/observe/scorecards/proc-configuring-github-scorecards-in-rhdh-instance.adoc
+18-23Lines changed: 18 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,30 +13,25 @@ You can view GitHub metrics for software components registered in the {product-v
13
13
* You must have {configuring-book-link}[added a custom {product-very-short} application configuration] and have enough permissions to change it.
14
14
15
15
.Procedure
16
+
To configure GitHub Scorecards in your RHDH instance, complete the following steps:
16
17
17
-
. Create and configure a GitHub App.
18
-
.. Create the GitHub App with **Read-only** permissions for **Contents** to allow reading repositories.
18
+
. To allow {product-very-short} to access the GitHub API, you must create and configure a GitHub App and add the necessary integration to your configuration file by completing the following steps:
19
+
.. Create a https://docs.github.com/en/apps/overview[GitHub App] with the required permissions (Read-onlyfor Contents to allow reading repositories).
19
20
.. Generate a client secret and a private key.
20
-
.. Install the app on the desired account or organization.
21
-
.. Save the following credential values:
21
+
.. Install the app on the desired account/organization.
22
+
.. Save the following values:
22
23
*** `App ID`
23
24
*** `Client ID`
24
25
*** `Client secret`
25
26
*** `Private key`
27
+
.. Add your GitHub credentials to {configuring-book-link}#provisioning-your-custom-configuration[your {product-very-short} secrets] using the following key/value pairs. You can use these secrets in the {product-very-short} configuration files by using their respective environment variable names.
. Configure the GitHub integration in your `{product-very-short} app-config.yaml`.
38
-
+
39
-
Add the `integrations.github` section to your custom `{product-very-short} app-config.yaml` configuration file using the environment variables:
34
+
. Configure the GitHub integration in your `{product-very-short} app-config.yaml`, by adding the `integrations.github` section to your custom `{product-very-short} app-config.yaml` configuration file:
40
35
+
41
36
[source,yaml]
42
37
----
@@ -51,9 +46,7 @@ integrations:
51
46
${GITHUB_INTEGRATION_PRIVATE_KEY_FILE}
52
47
----
53
48
54
-
. Annotate the component entity in `catalog-info.yaml`.
55
-
+
56
-
Link a software component to the GitHub data source by adding the required annotations to its `catalog-info.yaml` file as shown in the following example:
49
+
. In your {product-very-short} entity that you want to configure for the GitHub Scorecard plugin, in the `catalog-info.yaml` file, link a component to the data source by adding the required annotations as shown in the following code:
57
50
+
58
51
[source,yaml]
59
52
----
@@ -82,9 +75,10 @@ Where:
82
75
====
83
76
You must add the team entity to the Catalog to ensure the provided permissions are applicable.
84
77
====
78
+
85
79
. (Optional) Configure metric threshold values.
86
-
+
87
-
To customize the thresholds for the **GitHub Open Pull Requests** (`github.open_prs`) metric, add the following section to your `app-config.yaml` file:
80
+
81
+
.. To customize the thresholds for the **GitHub Open Pull Requests** (`github.open_prs`) metric, add the following section to your `app-config.yaml` file:
88
82
+
89
83
[source,yaml]
90
84
----
@@ -101,7 +95,8 @@ scorecard:
101
95
- key: error
102
96
expression: '>50'
103
97
----
104
-
+
98
+
where:
99
+
105
100
`scorecard:plugins:github:open_prs:thresholds`:: Lists the default threshold values for the GitHub open PRs metric.
Copy file name to clipboardExpand all lines: modules/observe/scorecards/proc-configuring-jira-scorecards-in-rhdh-instance.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ plugins:
44
44
where:
45
45
46
46
`baseUrl`:: Enter the Jira URL.
47
-
`token`:: Enter the Jira token (Base64 string for Cloud, PAT for Data Center).
47
+
`token`:: Enter the Jira token (Base64 string for Cloud, PAT for Data Center). The Jira token must be added as a secret file in your {configuring-book-link}#provisioning-your-custom-configuration[`{product} app-config.yaml` file].
48
48
`product`:: Enter the supported product: `cloud` or `datacenter`.
49
49
50
50
.. Use a proxy setup: In your `{product-very-short} dynamic-plugins-config.yaml`, add the following code:
0 commit comments