├── .github ├── dependabot.yml └── workflows │ └── npm-publish.yml ├── .gitignore ├── .pre-commit-config.yaml ├── LICENSE ├── README.md ├── package.json ├── src ├── api │ ├── GithubApi.ts │ ├── GithubClient.ts │ └── index.ts ├── assets │ ├── github.svg │ └── statusneo.png ├── components │ ├── CustomTable │ │ ├── CustomTable.tsx │ │ └── index.ts │ ├── GithubActionsCard │ │ ├── ActionDetailPanel.tsx │ │ ├── GithubActionsCard.tsx │ │ ├── columns.tsx │ │ └── index.ts │ ├── SignInContent.tsx │ └── UserPullRequestsCard │ │ ├── Icons.tsx │ │ ├── UserPullRequestsCard.tsx │ │ ├── columns.tsx │ │ └── index.ts ├── hoc │ ├── UserProvider.tsx │ └── withQueryClient.tsx ├── hooks │ ├── useAuthUser.ts │ ├── useSignIn.ts │ ├── useUserPullRequests.ts │ ├── useUserRepos.ts │ ├── useWorkflowRunJobs.ts │ └── useWorkflowRuns.ts ├── index.ts ├── plugin.test.ts ├── plugin.ts ├── setupTests.ts └── utils │ └── types.ts ├── tsconfig.json └── yarn.lock /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "npm" # See documentation for possible values 4 | directory: "/" # Location of package manifests 5 | schedule: 6 | interval: "weekly" 7 | -------------------------------------------------------------------------------- /.github/workflows/npm-publish.yml: -------------------------------------------------------------------------------- 1 | name: Release Backstage GitHub Plugin 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | jobs: 8 | validate-and-publish: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v3 12 | - uses: actions/setup-node@v3 13 | with: 14 | node-version: 18 15 | registry-url: https://registry.npmjs.org/ 16 | - name: Install dependencies, build, and publish 17 | run: | 18 | npm i -g yarn 19 | yarn install 20 | yarn tsc 21 | yarn build 22 | npm publish 23 | env: 24 | NODE_AUTH_TOKEN: ${{secrets.npm_token}} 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | 106 | dist 107 | dist-types 108 | 109 | .yarn 110 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | repos: 2 | - repo: https://github.com/pre-commit/pre-commit-hooks 3 | rev: v4.3.0 4 | hooks: 5 | - id: check-merge-conflict 6 | - id: trailing-whitespace 7 | - id: end-of-file-fixer 8 | - id: check-docstring-first 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## GitHub Homepage Cards for Backstage Enterprise 2 | 3 |
4 | 5 | To know more about the plugin, read this [blog](https://statusneo.com/23468-2). 6 | 7 | ### Setup 8 | 9 | Before you can start using the GitHub cards, you must set up a GitHub provider. 10 | 11 | You can follow this [documentation](https://backstage.io/docs/auth/github/provider/) which will guide you through the process of setting up the GitHub provider for your Backstage instance. 12 | 13 | Now in the below steps, I will assume you are already done with the provider. 14 | 15 | ### Integration Steps 16 | 17 | 1. First Install the GitHub cards plugin by running this command from the root of the package. 18 | 19 | ```shell 20 | yarn add –cwd packages/app @statusneo/backstage-plugin-github 21 | ``` 22 | 2. add this to the app/src/apis.ts 23 | 24 | ```javascript 25 | import { githubApiRef, GithubClient as StatusNeoGithubClient } from '@statusneo/backstage-plugin-github'; 26 | 27 | // ... 28 | createApiFactory({ 29 | api: githubApiRef, 30 | deps: { authApi: githubAuthApiRef, fetchApi: fetchApiRef, configApi: configApiRef }, 31 | factory(deps) { 32 | return new StatusNeoGithubClient(deps); 33 | }, 34 | }), 35 | // ... 36 | ``` 37 | 38 | 3. Import `GithubPullRequestsCard`, and `GithubActionsCard` from the installed package. 39 | 40 | 4. You can then use these components at the backstage frontend wherever you need. 41 | 42 | ```javascript 43 | import { GithubPullRequestsCard, GithubActionsCard } from '@statusneo/backstage-plugin-github'; 44 | 45 | // ... 46 | 47 | 48 | 49 | 50 | 51 | 52 | // ... 53 | ``` 54 | 55 | 5. If you are using a GitHub enterprise edition, you can pass your instance url through app-config.yml 56 | 57 | ```yaml 58 | 59 | gh-plugin: 60 | url: ${GITHUB_ENTERPRISE_URL} 61 | 62 | ``` 63 | 64 | Now you are ready to use this Backstage GitHub plugin to make your software management and development cycle a little more hassle-free. 65 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@statusneo/backstage-plugin-github", 3 | "version": "0.2.6", 4 | "main": "src/index.ts", 5 | "types": "src/index.ts", 6 | "license": "ISC", 7 | "publishConfig": { 8 | "access": "public", 9 | "main": "dist/index.esm.js", 10 | "types": "dist/index.d.ts" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "https://github.com/StatusNeo/backstage-plugin-github" 15 | }, 16 | "backstage": { 17 | "role": "frontend-plugin" 18 | }, 19 | "author": { 20 | "email": "reach@statusneo.com", 21 | "url": "https://statusneo.com/", 22 | "name": "statusneo" 23 | }, 24 | "scripts": { 25 | "start": "backstage-cli package start", 26 | "build": "backstage-cli package build", 27 | "lint": "backstage-cli package lint", 28 | "test": "backstage-cli package test", 29 | "clean": "backstage-cli package clean", 30 | "prepack": "backstage-cli package prepack", 31 | "postpack": "backstage-cli package postpack" 32 | }, 33 | "dependencies": { 34 | "@backstage/core-components": "^0.13.3", 35 | "@backstage/core-plugin-api": "^1.3.0", 36 | "@backstage/errors": "^1.1.4", 37 | "@backstage/theme": "^0.2.16", 38 | "@material-table/core": "v3.1.0", 39 | "@material-ui/core": "^4.12.2", 40 | "@material-ui/icons": "^4.9.1", 41 | "@material-ui/lab": "^4.0.0-alpha.57", 42 | "@tanstack/react-query": "^4.32.6", 43 | "react-use": "^17.2.4" 44 | }, 45 | "peerDependencies": { 46 | "react": "^16.13.1 || ^17.0.0", 47 | "react-dom": "^16.13.1 || ^17.0.0" 48 | }, 49 | "devDependencies": { 50 | "@backstage/cli": "^0.22.1", 51 | "@backstage/core-app-api": "^1.4.0", 52 | "@backstage/dev-utils": "^1.0.11", 53 | "@backstage/test-utils": "^1.2.4", 54 | "@testing-library/jest-dom": "^5.10.1", 55 | "@testing-library/react": "^12.1.3", 56 | "@testing-library/user-event": "^14.0.0", 57 | "@types/node": "*", 58 | "cross-fetch": "^3.1.5", 59 | "msw": "^1.2.3" 60 | }, 61 | "files": [ 62 | "dist" 63 | ], 64 | "contributors": [ 65 | { 66 | "email": "abhaysoni.developer@gmail.com", 67 | "url": "https://github.com/Abhay-soni-developer", 68 | "name": "abhaysoni" 69 | } 70 | ], 71 | "maintainers": [ 72 | { 73 | "email": "abhaysoni.developer@gmail.com", 74 | "url": "https://github.com/Abhay-soni-developer", 75 | "name": "abhaysoni" 76 | }, 77 | { 78 | "email": "nishkarshraj000@gmail.com", 79 | "url": "https://github.com/NishkarshRaj", 80 | "name": "nishkarshraj" 81 | } 82 | ], 83 | "keywords": [ 84 | "backstage", 85 | "statusneo", 86 | "github" 87 | ], 88 | "configSchema": { 89 | "$schema": "https://backstage.io/schema/config-v1", 90 | "title": "@statusneo/backstage-plugin-github", 91 | "type": "object", 92 | "properties": { 93 | "gh-plugin": { 94 | "type": "object", 95 | "properties": { 96 | "url": { 97 | "type": "string", 98 | "visibility": "frontend" 99 | } 100 | } 101 | } 102 | } 103 | } 104 | } 105 | -------------------------------------------------------------------------------- /src/api/GithubApi.ts: -------------------------------------------------------------------------------- 1 | import { createApiRef } from '@backstage/core-plugin-api'; 2 | import { SearchApiResponse, UserProfile, UserRepositoryApiRequest, UserRepositoryApiResponse, WorkflowRunApiRequest, WorkflowRunApiResponse, WorkflowRunJobApiRequest, WorkflowRunJobApiResponse } from '../utils/types'; 3 | 4 | export interface GithubApi { 5 | getUserPullRequest: (params: any) => Promise; 6 | getAuthenticatedUser: ()=>Promise 7 | getAuthenticatedUserToken: ()=>Promise 8 | getWorkflowRuns: (params: WorkflowRunApiRequest)=>Promise 9 | getWorkflowJobsByWorkflowId: (params: WorkflowRunJobApiRequest)=>Promise 10 | getAuthenticatedUserReposByType: (params: UserRepositoryApiRequest) => Promise 11 | } 12 | 13 | export const githubApiRef = createApiRef({ 14 | id: 'plugin.github.statusneo.service', 15 | }); 16 | -------------------------------------------------------------------------------- /src/api/GithubClient.ts: -------------------------------------------------------------------------------- 1 | import { GithubApi } from './GithubApi'; 2 | import { OAuthApi, FetchApi, ConfigApi } from '@backstage/core-plugin-api'; 3 | import { ResponseError } from '@backstage/errors'; 4 | import { 5 | SearchApiFetchRequest, 6 | SearchApiResponse, 7 | UserProfile, 8 | UserRepositoryApiRequest, 9 | UserRepositoryApiResponse, 10 | WorkflowRunApiRequest, 11 | WorkflowRunApiResponse, 12 | WorkflowRunJobApiRequest, 13 | WorkflowRunJobApiResponse, 14 | } from '../utils/types'; 15 | 16 | /** @public */ 17 | export class GithubClient implements GithubApi { 18 | private readonly authApi: OAuthApi; 19 | private readonly fetchApi: FetchApi; 20 | private readonly configApi: ConfigApi; 21 | 22 | constructor(options: { 23 | authApi: OAuthApi; 24 | fetchApi: FetchApi; 25 | configApi: ConfigApi; 26 | }) { 27 | this.authApi = options.authApi; 28 | this.fetchApi = options.fetchApi; 29 | this.configApi = options.configApi; 30 | } 31 | 32 | private async get( 33 | path: string, 34 | params: { [key in string]: any } = {}, 35 | ): Promise { 36 | const query = new URLSearchParams(params); 37 | 38 | const baseUrl: string = 39 | this.configApi.getOptionalString('gh-plugin.url') || 'https://api.github.com/'; 40 | 41 | const url = new URL( 42 | `${path}?${query.toString().replaceAll('%2B', '+')}`, 43 | baseUrl, 44 | ); 45 | 46 | const token = await this.authApi.getAccessToken(); 47 | 48 | const response = await this.fetchApi.fetch(url.toString(), { 49 | headers: { 50 | Authorization: `Bearer ${token}`, 51 | }, 52 | }); 53 | 54 | if (!response.ok) { 55 | throw await ResponseError.fromResponse(response); 56 | } 57 | 58 | return response.json() as Promise; 59 | } 60 | 61 | public getUserPullRequest( 62 | params: SearchApiFetchRequest, 63 | ): Promise { 64 | return this.get(`search/issues`, params); 65 | } 66 | 67 | public getAuthenticatedUser(): Promise { 68 | return this.get('user', {}); 69 | } 70 | 71 | public getAuthenticatedUserToken(): Promise { 72 | return this.authApi.getAccessToken(); 73 | } 74 | 75 | public getWorkflowRuns( 76 | params: WorkflowRunApiRequest, 77 | ): Promise { 78 | const { repoPath, ...queryParams } = params; 79 | return this.get( 80 | `repos/${repoPath}/actions/runs`, 81 | queryParams, 82 | ); 83 | } 84 | 85 | public getWorkflowJobsByWorkflowId( 86 | params: WorkflowRunJobApiRequest, 87 | ): Promise { 88 | const { repoPath, run_id } = params; 89 | return this.get( 90 | `repos/${repoPath}/actions/runs/${run_id}/jobs`, 91 | {}, 92 | ); 93 | } 94 | 95 | public getAuthenticatedUserReposByType( 96 | params: UserRepositoryApiRequest, 97 | ): Promise { 98 | return this.get(`/user/repos`, params); 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /src/api/index.ts: -------------------------------------------------------------------------------- 1 | export * from "./GithubApi"; 2 | export * from "./GithubClient"; 3 | -------------------------------------------------------------------------------- /src/assets/github.svg: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /src/assets/statusneo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/StatusNeo/backstage-plugin-github/83ef956d8d320b2006d2d8b9a0a64cd648cf2055/src/assets/statusneo.png -------------------------------------------------------------------------------- /src/components/CustomTable/CustomTable.tsx: -------------------------------------------------------------------------------- 1 | import { 2 | Table, 3 | TableColumn 4 | } from '@backstage/core-components'; 5 | import { BackstageTheme } from '@backstage/theme'; 6 | import { MTablePagination, MTableHeader } from '@material-table/core'; 7 | import { withStyles } from '@material-ui/core/styles'; 8 | import React from 'react'; 9 | import { UserProfile } from '../../utils/types'; 10 | import { SignInContent } from '../SignInContent'; 11 | 12 | export type CustomTableProps = { 13 | title: string | JSX.Element; 14 | subtitle: string; 15 | columns: TableColumn[]; 16 | data: T[]; 17 | isLoading: boolean; 18 | signIn: (instantPopup: boolean) => void; 19 | isSignedIn: boolean; 20 | isInitialized: boolean; 21 | isError: boolean; 22 | error?: any; 23 | user: UserProfile | null; // github user profile 24 | detailPanel?: ({ rowData }: { rowData: T }) => React.ReactNode; 25 | columnsButton?: boolean; 26 | } & PaginationProps & 27 | SearchProps; 28 | 29 | type PaginationProps = 30 | | { 31 | paging?: never; 32 | totalCount?: never; 33 | page?: never; 34 | setPage?: never; 35 | pageSize?: never; 36 | setPageSize?: never; 37 | } 38 | | { 39 | paging: boolean; 40 | totalCount: number; 41 | page: number; 42 | setPage: (newPage: number) => void; 43 | pageSize: number; 44 | setPageSize: (newPageSize: number) => void; 45 | }; 46 | 47 | type SearchProps = 48 | | { 49 | isSearchAvailable?: never; 50 | setSearchText?: never; 51 | searchPlaceholder?: never; 52 | searchTooltip?: never; 53 | } 54 | | { 55 | isSearchAvailable: boolean; 56 | setSearchText: (searchText: string) => void; 57 | searchPlaceholder?: string; 58 | searchTooltip?: string; 59 | }; 60 | 61 | CustomTable.defaultProps = { 62 | title: '', 63 | subtitle: '', 64 | columns: [], 65 | data: [], 66 | isLoading: false, 67 | paging: false, 68 | isSearchAvailable: false, 69 | totalCount: 0, 70 | searchPlaceholder: 'search', 71 | searchTooltip: 'search', 72 | pageSize: 0, 73 | page: 1, 74 | select: false, 75 | columnsButton: false 76 | }; 77 | 78 | const StyledMTableHeader = withStyles( 79 | theme => ({ 80 | header: { 81 | padding: theme.spacing(1, 2, 1, 2.5), 82 | borderTop: `1px solid ${theme.palette.grey.A100}`, 83 | borderBottom: `1px solid ${theme.palette.grey.A100}`, 84 | // withStyles hasn't a generic overload for theme 85 | color: (theme as BackstageTheme).palette.textSubtle, 86 | fontWeight: 'bold', 87 | position: 'static', 88 | wordBreak: 'normal', 89 | }, 90 | }), 91 | { name: 'BackstageTableHeader' }, 92 | )(MTableHeader); 93 | 94 | export function CustomTable(props: CustomTableProps) { 95 | return ( 96 | 97 | title={props.title} 98 | subtitle={props.subtitle} 99 | columns={props.columns} 100 | isLoading={props.isLoading} 101 | options={{ 102 | search: props.isSearchAvailable, 103 | paging: props.paging, 104 | padding: 'dense', 105 | toolbar: true, 106 | filtering: false, 107 | showFirstLastPageButtons: true, 108 | paginationType: 'stepped', 109 | loadingType: 'linear', 110 | emptyRowsWhenPaging: true, 111 | tableLayout: 'auto', 112 | debounceInterval: 350, 113 | sorting: false, 114 | columnsButton: props.columnsButton, 115 | }} 116 | localization={{ 117 | toolbar: { 118 | searchPlaceholder: props.searchPlaceholder, 119 | searchTooltip: props.searchTooltip, 120 | }, 121 | }} 122 | data={props.data} 123 | onSearchChange={(searchText: string) => { 124 | if (props.isSearchAvailable) { 125 | props.setSearchText(searchText); 126 | } 127 | }} 128 | emptyContent={ 129 | <> 130 | {!props.isSignedIn && ( 131 | props.signIn(false)} /> 132 | )} 133 | 134 | } 135 | components={{ 136 | Pagination: paginationProps => { 137 | const { classes, ...remainingProps } = paginationProps; 138 | return ( 139 | { 145 | if (props.paging) { 146 | props.setPage(newPage); 147 | } 148 | }} 149 | /> 150 | ); 151 | }, 152 | // @ts-ignore 153 | Header: headerProps => , 154 | }} 155 | detailPanel={props.detailPanel} 156 | /> 157 | ); 158 | } 159 | -------------------------------------------------------------------------------- /src/components/CustomTable/index.ts: -------------------------------------------------------------------------------- 1 | export * from "./CustomTable" 2 | -------------------------------------------------------------------------------- /src/components/GithubActionsCard/ActionDetailPanel.tsx: -------------------------------------------------------------------------------- 1 | import React, { useEffect } from 'react'; 2 | import { makeStyles } from '@material-ui/core/styles'; 3 | import Tabs from '@material-ui/core/Tabs'; 4 | import Tab from '@material-ui/core/Tab'; 5 | import { Paper } from '@material-ui/core'; 6 | import { WorkflowRun, WorkflowRunJob } from '../../utils/types'; 7 | import { useWorkflowRunJobs } from '../../hooks/useWorkflowRunJobs'; 8 | import Timeline from '@material-ui/lab/Timeline'; 9 | import TimelineItem from '@material-ui/lab/TimelineItem'; 10 | import TimelineSeparator from '@material-ui/lab/TimelineSeparator'; 11 | import TimelineConnector from '@material-ui/lab/TimelineConnector'; 12 | import TimelineContent from '@material-ui/lab/TimelineContent'; 13 | import TimelineDot from '@material-ui/lab/TimelineDot'; 14 | import TimelineOppositeContent from '@material-ui/lab/TimelineOppositeContent'; 15 | import Typography from '@material-ui/core/Typography'; 16 | import { Progress } from '@backstage/core-components'; 17 | 18 | const useStyles = makeStyles(theme => ({ 19 | root: { 20 | flexGrow: 1, 21 | backgroundColor: theme.palette.background.paper, 22 | display: 'flex', 23 | maxHeight: 250, 24 | borderBottom: `1px solid ${theme.palette.divider}`, 25 | }, 26 | tabs: { 27 | flex: 1, 28 | borderRight: `1px solid ${theme.palette.divider}`, 29 | }, 30 | timelineContainer: { 31 | flex: 3, 32 | maxHeight: 250, 33 | overflowY: 'scroll' 34 | }, 35 | "dot-success": { 36 | backgroundColor: '#1a7f37' 37 | }, 38 | "dot-error": { 39 | backgroundColor: 'rgba(255,129,130,0.4)' 40 | }, 41 | "dot-warning": { 42 | backgroundColor: '#bf8700' 43 | }, 44 | "dot-default": { 45 | backgroundColor: '#e2e2e2' 46 | } 47 | })); 48 | 49 | export function ActionDetailPanel({ rowData }: { rowData: WorkflowRun }) { 50 | const [activeJobId, setActiveJobId] = React.useState(''); 51 | const classes = useStyles(); 52 | 53 | const handleChange = (_event: React.ChangeEvent<{}>, newValue: string) => { 54 | setActiveJobId(newValue); 55 | }; 56 | 57 | const { data, isLoading, isError } = useWorkflowRunJobs({ 58 | run_id: rowData.id, 59 | repoPath: rowData.repository.full_name, 60 | }); 61 | 62 | useEffect(() => { 63 | if (data?.jobs && data?.total_count > 0) { 64 | setActiveJobId(data.jobs[0].id); 65 | } 66 | }, [data]); 67 | 68 | if (isLoading || isError) { 69 | return ; 70 | } 71 | 72 | return ( 73 | 80 | 87 | {data?.jobs.map(job => ( 88 | 89 | ))} 90 | 91 | 98 | {data?.jobs.map(job => ( 99 | 105 | ))} 106 | 107 | 108 | ); 109 | } 110 | 111 | function WorkflowRunJobCard({ 112 | job, 113 | activeJobId, 114 | classes 115 | }: { 116 | job: WorkflowRunJob; 117 | activeJobId: string; 118 | classes: ReturnType 119 | }) { 120 | 121 | if (job.id !== activeJobId) { 122 | return null; 123 | } 124 | 125 | let status: 'success' | 'warning' | 'error' | 'default'; 126 | 127 | switch (job.status) { 128 | case 'completed': 129 | case 'success': 130 | status='success' 131 | break; 132 | case 'action_required': 133 | case 'queued': 134 | case 'pending': 135 | case 'in_progress': 136 | case 'waiting': 137 | status='error' 138 | break; 139 | case 'cancelled': 140 | case 'failure': 141 | case 'timed_out': 142 | status='warning' 143 | break; 144 | default: 145 | status='default' 146 | } 147 | return ( 148 | 149 | {job.steps.map(step => ( 150 | 151 | 152 | 153 | {`${new Date(step.completed_at).toLocaleDateString()}`} 154 | 155 |
156 | 157 | {`${new Date(step.completed_at).toLocaleTimeString()}`} 158 | 159 | 160 | 161 | 164 | 165 | 166 | 167 | {step.name} 168 | 169 | 170 | ))} 171 | 172 | ); 173 | } 174 | -------------------------------------------------------------------------------- /src/components/GithubActionsCard/GithubActionsCard.tsx: -------------------------------------------------------------------------------- 1 | import { CustomTable } from '../CustomTable'; 2 | import React, { useEffect, useMemo, useState } from 'react'; 3 | import { workflow_branch, workflow_status, workflow_title } from './columns'; 4 | import { WorkflowRun } from '../../utils/types'; 5 | import { Select, TableColumn } from '@backstage/core-components'; 6 | import { useWorkflowRuns } from '../../hooks/useWorkflowRuns'; 7 | import { useUserRepos } from '../../hooks/useUserRepos'; 8 | import { ActionDetailPanel } from './ActionDetailPanel'; 9 | import { makeStyles } from '@material-ui/core'; 10 | import { withQueryClient } from '../../hoc/withQueryClient'; 11 | import { UserContext, withUser } from '../../hoc/UserProvider'; 12 | 13 | const useStyles = makeStyles(() => ({ 14 | container: { 15 | position: 'relative', 16 | }, 17 | 18 | selectContainer: { 19 | zIndex: 100, 20 | position: 'absolute', 21 | right: 48, 22 | top: 4, 23 | }, 24 | })); 25 | 26 | function GithubActions() { 27 | const columns: TableColumn[] = useMemo( 28 | () => [workflow_title, workflow_branch, workflow_status], 29 | [], 30 | ); 31 | 32 | const styles = useStyles(); 33 | 34 | const { isSignedIn, isInitialized, signIn, user } = 35 | React.useContext(UserContext); 36 | 37 | const [page, setPage] = useState(0); 38 | const [pageSize, setPageSize] = useState(5); 39 | 40 | // get user repo where user is either owner/member. 41 | const repos = useUserRepos(); 42 | const [selectedItem, setSelectedItem] = useState(''); 43 | 44 | const selectItems = useMemo(() => { 45 | return [ 46 | ...repos.map(repo => ({ 47 | label: repo.full_name, 48 | value: repo.full_name, 49 | })), 50 | ]; 51 | }, [repos]); 52 | 53 | useEffect(() => { 54 | if (selectItems && selectItems.length >= 1) { 55 | setSelectedItem(selectItems[0].value); 56 | } 57 | }, [selectItems]); 58 | 59 | const { data, isLoading, isError, error } = useWorkflowRuns({ 60 | repoPath: selectedItem, 61 | page: page + 1, 62 | per_page: pageSize, 63 | }); 64 | 65 | return ( 66 |
67 |
68 |