@backstage-community/plugin-github-actions 0.6.19 → 0.6.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +16 -4
- package/alpha/package.json +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -27,8 +27,22 @@ TBD
|
|
|
27
27
|
|
|
28
28
|
1. Provide OAuth credentials:
|
|
29
29
|
1. [Create an OAuth App](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/) in the GitHub organization with the callback URL set to `http://localhost:7007/api/auth/github/handler/frame`.
|
|
30
|
-
|
|
31
|
-
|
|
30
|
+
**Note**: This can be done with a user account also. Depending on if you use a personal account or an organization account will change the repositories this is functional with
|
|
31
|
+
1. Take the Client ID and Client Secret from the newly created app's settings page and you can do either:
|
|
32
|
+
|
|
33
|
+
1. Put them into `AUTH_GITHUB_CLIENT_ID` and `AUTH_GITHUB_CLIENT_SECRET` environment variables.
|
|
34
|
+
2. Add them to the app-config like below:
|
|
35
|
+
|
|
36
|
+
```yaml
|
|
37
|
+
auth:
|
|
38
|
+
providers:
|
|
39
|
+
github:
|
|
40
|
+
development:
|
|
41
|
+
clientId: ${AUTH_GITHUB_CLIENT_ID}
|
|
42
|
+
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
1. Annotate your component with a correct GitHub Actions repository and owner:
|
|
32
46
|
|
|
33
47
|
The annotation key is `github.com/project-slug`.
|
|
34
48
|
|
|
@@ -140,8 +154,6 @@ integrations:
|
|
|
140
154
|
## Limitations
|
|
141
155
|
|
|
142
156
|
- There is a limit of 100 apps for one OAuth client/token pair
|
|
143
|
-
- The OAuth application must be at the GitHub organization level in order to display the workflows. If you do
|
|
144
|
-
not see any workflows, confirm the OAuth application was created in the organization and not a specific user account.
|
|
145
157
|
|
|
146
158
|
## Optional Workflow Runs Card View
|
|
147
159
|
|
package/alpha/package.json
CHANGED