paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 48 Packages Projects Releases Wiki Activity

update for comments

Browse Source 
Signed-off-by: Andrew Johnson <ajohnson@gocardless.com>
This commit is contained in:
Andrew Johnson
2021-03-30 17:35:53 +01:00
parent 4b00af9b31
commit 39d7c8718a
8 changed files with 50 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/github-deployments/README.md
+8 -13
View File
@@ -4,18 +4,13 @@ The GitHub Deployments Plugin displays recent deployments from GitHub.
![github-deployments-card](./docs/github-deployments-card.png)
## Prerequisites
- [GitHub Authentication Provider](https://backstage.io/docs/auth/github/provider)
## Getting Started
1. Provide OAuth credentials:
- Create an [OAuth App](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/) and set env variables for ID and Secret.
```bash
export AUTH_GITHUB_CLIENT_ID={{YOUR_CLIENT_ID}}
export AUTH_CLIENT_SECRET={{YOUR_CLIENT_SECRET}}
```
2. Install the GitHub Deployments Plugin.
1. Install the GitHub Deployments Plugin.
```bash
# packages/app
@@ -23,7 +18,7 @@ export AUTH_CLIENT_SECRET={{YOUR_CLIENT_SECRET}}
yarn add @backstage/plugin-github-deployments
```
3. Add the plugin to the app
2. Add the plugin to the app
```typescript
// packages/app/src/plugins.ts
@@ -31,7 +26,7 @@ yarn add @backstage/plugin-github-deployments
export { plugin as GithubDeployments } from '@backstage/plugin-github-deployments';
```
4. Add the `EntityGithubDeploymentsCard` to the EntityPage:
3. Add the `EntityGithubDeploymentsCard` to the EntityPage:
```typescript
// packages/app/src/components/catalog/EntityPage.tsx
@@ -49,7 +44,7 @@ const OverviewContent = () => (
);
```
5. Add the `github.com/project-slug` annotation to your `catalog-info.yaml` file:
4. Add the `github.com/project-slug` annotation to your `catalog-info.yaml` file:
```yaml
apiVersion: backstage.io/v1alpha1