@backstage-community/plugin-github-actions 0.6.23 → 0.6.24
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 +27 -6
- package/alpha/package.json +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -9,6 +9,7 @@ Website: [https://github.com/actions](https://github.com/actions)
|
|
|
9
9
|
- [Screenshots](#screenshots)
|
|
10
10
|
- [Setup](#setup)
|
|
11
11
|
- [Generic Requirements](#generic-requirements)
|
|
12
|
+
- [Provide OAuth Credentials](#provide-oauth-credentials)
|
|
12
13
|
- [Installation](#installation)
|
|
13
14
|
- [Integrating with `EntityPage`](#integrating-with-entitypage)
|
|
14
15
|
- [Integrating with `EntityPage` (New Frontend System)](#integrating-with-entitypage-new-frontend-system)
|
|
@@ -25,13 +26,21 @@ TBD
|
|
|
25
26
|
|
|
26
27
|
### Generic Requirements
|
|
27
28
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
29
|
+
#### Provide OAuth Credentials
|
|
30
|
+
|
|
31
|
+
Create an OAuth App in your GitHub organization, setting the callback URL to:
|
|
32
|
+
|
|
33
|
+
`http://localhost:7007/api/auth/github/handler/frame`
|
|
34
|
+
|
|
35
|
+
Replacing `localhost:7007` with the base URL of your backstage backend instance.
|
|
36
|
+
|
|
37
|
+
> **Note**: This setup can also be completed with a personal GitHub account.
|
|
38
|
+
> Keep in mind that using a personal account versus an organization account will affect which repositories the app can access.
|
|
39
|
+
|
|
31
40
|
1. Take the Client ID and Client Secret from the newly created app's settings page and you can do either:
|
|
32
41
|
|
|
33
|
-
|
|
34
|
-
|
|
42
|
+
- Put them into `AUTH_GITHUB_CLIENT_ID` and `AUTH_GITHUB_CLIENT_SECRET` environment variables.
|
|
43
|
+
- Add them to the app-config like below:
|
|
35
44
|
|
|
36
45
|
```yaml
|
|
37
46
|
auth:
|
|
@@ -42,7 +51,7 @@ TBD
|
|
|
42
51
|
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
|
|
43
52
|
```
|
|
44
53
|
|
|
45
|
-
|
|
54
|
+
2. Annotate your component with a correct GitHub Actions repository and owner:
|
|
46
55
|
|
|
47
56
|
The annotation key is `github.com/project-slug`.
|
|
48
57
|
|
|
@@ -71,6 +80,18 @@ TBD
|
|
|
71
80
|
yarn --cwd packages/app add @backstage-community/plugin-github-actions
|
|
72
81
|
```
|
|
73
82
|
|
|
83
|
+
> **Note**: If you are using GitHub auth to sign in, you may already have the GitHub provider, **if it is not the case**, install it by running:
|
|
84
|
+
>
|
|
85
|
+
> ```tsx
|
|
86
|
+
> yarn --cwd packages/backend add @backstage/plugin-auth-backend-module-github-provider
|
|
87
|
+
> ```
|
|
88
|
+
>
|
|
89
|
+
> And add the following dependency to your backend index file:
|
|
90
|
+
>
|
|
91
|
+
> ```tsx
|
|
92
|
+
> backend.add(import('@backstage/plugin-auth-backend-module-github-provider'));
|
|
93
|
+
> ```
|
|
94
|
+
|
|
74
95
|
### Integrating with `EntityPage`
|
|
75
96
|
|
|
76
97
|
1. Add to the app `EntityPage` component:
|
package/alpha/package.json
CHANGED