@backstage-community/plugin-github-actions 0.6.22 → 0.6.24

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage-community/plugin-github-actions
 
+## 0.6.24
+
+### Patch Changes
+
+- 9501620: Updating README to include missing steps
+
+## 0.6.23
+
+### Patch Changes
+
+- 6fdae83: Backstage version bump to v1.32.0
+
 ## 0.6.22
 
 ### Patch Changes

package/README.md

@@ -9,6 +9,7 @@ Website: [https://github.com/actions](https://github.com/actions)
   - [Screenshots](#screenshots)
   - [Setup](#setup)
     - [Generic Requirements](#generic-requirements)
+      - [Provide OAuth Credentials](#provide-oauth-credentials)
     - [Installation](#installation)
     - [Integrating with `EntityPage`](#integrating-with-entitypage)
     - [Integrating with `EntityPage` (New Frontend System)](#integrating-with-entitypage-new-frontend-system)
@@ -25,13 +26,21 @@ TBD
 
 ### Generic Requirements
 
-1. Provide OAuth credentials:
-   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`.
-      **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
+#### Provide OAuth Credentials
+
+Create an OAuth App in your GitHub organization, setting the callback URL to:
+
+`http://localhost:7007/api/auth/github/handler/frame`
+
+Replacing `localhost:7007` with the base URL of your backstage backend instance.
+
+> **Note**: This setup can also be completed with a personal GitHub account.  
+> Keep in mind that using a personal account versus an organization account will affect which repositories the app can access.
+
 1. Take the Client ID and Client Secret from the newly created app's settings page and you can do either:
 
-   1. Put them into `AUTH_GITHUB_CLIENT_ID` and `AUTH_GITHUB_CLIENT_SECRET` environment variables.
-   2. Add them to the app-config like below:
+   - Put them into `AUTH_GITHUB_CLIENT_ID` and `AUTH_GITHUB_CLIENT_SECRET` environment variables.
+   - Add them to the app-config like below:
 
    ```yaml
    auth:
@@ -42,7 +51,7 @@ TBD
            clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
    ```
 
-1. Annotate your component with a correct GitHub Actions repository and owner:
+2. Annotate your component with a correct GitHub Actions repository and owner:
 
    The annotation key is `github.com/project-slug`.
 
@@ -71,6 +80,18 @@ TBD
 yarn --cwd packages/app add @backstage-community/plugin-github-actions
 ```
 
+> **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:
+>
+> ```tsx
+> yarn --cwd packages/backend add @backstage/plugin-auth-backend-module-github-provider
+> ```
+>
+> And add the following dependency to your backend index file:
+>
+> ```tsx
+> backend.add(import('@backstage/plugin-auth-backend-module-github-provider'));
+> ```
+
 ### Integrating with `EntityPage`
 
 1. Add to the app `EntityPage` component:

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-github-actions__alpha",
-  "version": "0.6.22",
+  "version": "0.6.24",
   "main": "../dist/alpha.esm.js",
   "module": "../dist/alpha.esm.js",
   "types": "../dist/alpha.d.ts"

package/dist/alpha/apis.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"apis.esm.js","sources":["../../src/alpha/apis.ts"],"sourcesContent":["import {\n  configApiRef,\n  ApiBlueprint,\n  createApiFactory,\n} from '@backstage/frontend-plugin-api';\nimport { scmAuthApiRef } from '@backstage/integration-react';\nimport { githubActionsApiRef, GithubActionsClient } from '../api';\n\n/**\n * @alpha\n */\nexport const githubActionsApi = ApiBlueprint.make({\n  params: {\n    factory: createApiFactory({\n      api: githubActionsApiRef,\n      deps: { configApi: configApiRef, scmAuthApi: scmAuthApiRef },\n      factory: ({ configApi, scmAuthApi }) =>\n        new GithubActionsClient({ configApi, scmAuthApi }),\n    }),\n  },\n});\n"],"names":[],"mappings":";;;;;AAWa,MAAA,gBAAA,GAAmB,aAAa,IAAK,CAAA;AAAA,EAChD,MAAQ,EAAA;AAAA,IACN,SAAS,gBAAiB,CAAA;AAAA,MACxB,GAAK,EAAA,mBAAA;AAAA,MACL,IAAM,EAAA,EAAE,SAAW,EAAA,YAAA,EAAc,YAAY,aAAc,EAAA;AAAA,MAC3D,OAAA,EAAS,CAAC,EAAE,SAAW,EAAA,UAAA,EACrB,KAAA,IAAI,mBAAoB,CAAA,EAAE,SAAW,EAAA,UAAA,EAAY,CAAA;AAAA,KACpD,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
+{"version":3,"file":"apis.esm.js","sources":["../../src/alpha/apis.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  configApiRef,\n  ApiBlueprint,\n  createApiFactory,\n} from '@backstage/frontend-plugin-api';\nimport { scmAuthApiRef } from '@backstage/integration-react';\nimport { githubActionsApiRef, GithubActionsClient } from '../api';\n\n/**\n * @alpha\n */\nexport const githubActionsApi = ApiBlueprint.make({\n  params: {\n    factory: createApiFactory({\n      api: githubActionsApiRef,\n      deps: { configApi: configApiRef, scmAuthApi: scmAuthApiRef },\n      factory: ({ configApi, scmAuthApi }) =>\n        new GithubActionsClient({ configApi, scmAuthApi }),\n    }),\n  },\n});\n"],"names":[],"mappings":";;;;;AA0Ba,MAAA,gBAAA,GAAmB,aAAa,IAAK,CAAA;AAAA,EAChD,MAAQ,EAAA;AAAA,IACN,SAAS,gBAAiB,CAAA;AAAA,MACxB,GAAK,EAAA,mBAAA;AAAA,MACL,IAAM,EAAA,EAAE,SAAW,EAAA,YAAA,EAAc,YAAY,aAAc,EAAA;AAAA,MAC3D,OAAA,EAAS,CAAC,EAAE,SAAW,EAAA,UAAA,EACrB,KAAA,IAAI,mBAAoB,CAAA,EAAE,SAAW,EAAA,UAAA,EAAY,CAAA;AAAA,KACpD,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/alpha/entityCards.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"entityCards.esm.js","sources":["../../src/alpha/entityCards.tsx"],"sourcesContent":["import React from 'react';\nimport { EntityCardBlueprint } from '@backstage/plugin-catalog-react/alpha';\n\n/**\n * @alpha\n */\nexport const entityGithubActionsCard = EntityCardBlueprint.make({\n  name: 'workflow-runs',\n  params: {\n    filter: 'kind:component',\n    loader: () =>\n      import('../components/Router').then(m => <m.Router view=\"cards\" />),\n  },\n});\n\n/**\n * @alpha\n */\nexport const entityLatestGithubActionRunCard =\n  EntityCardBlueprint.makeWithOverrides({\n    name: 'latest-workflow-run',\n    config: {\n      schema: {\n        props: z =>\n          z\n            .object({\n              branch: z.string().default('master'),\n            })\n            .default({}),\n      },\n    },\n    factory(originalFactory, { config }) {\n      return originalFactory({\n        filter: 'kind:component',\n        loader: async () =>\n          import('../components/Cards').then(m => (\n            <m.LatestWorkflowRunCard {...config.props} />\n          )),\n      });\n    },\n  });\n\n/**\n * @alpha\n */\nexport const entityLatestGithubActionsForBranchCard =\n  EntityCardBlueprint.makeWithOverrides({\n    name: 'latest-branch-workflow-runs',\n    config: {\n      schema: {\n        props: z =>\n          z\n            .object({\n              branch: z.string().default('master'),\n            })\n            .default({}),\n      },\n    },\n    factory(originalFactory, { config }) {\n      return originalFactory({\n        filter: 'kind:component',\n        loader: async () =>\n          import('../components/Cards').then(m => (\n            <m.LatestWorkflowsForBranchCard {...config.props} />\n          )),\n      });\n    },\n  });\n\n/**\n * @alpha\n */\nexport const entityRecentGithubActionsRunsCard =\n  EntityCardBlueprint.makeWithOverrides({\n    name: 'recent-workflow-runs',\n    config: {\n      schema: {\n        props: z =>\n          z\n            .object({\n              branch: z.string().default('master'),\n              dense: z.boolean().default(false),\n              limit: z.number().default(5).optional(),\n            })\n            .default({}),\n      },\n    },\n    factory(originalFactory, { config }) {\n      return originalFactory({\n        filter: 'kind:component',\n        loader: async () =>\n          import('../components/Cards').then(m => (\n            <m.RecentWorkflowRunsCard {...config.props} />\n          )),\n      });\n    },\n  });\n"],"names":[],"mappings":";;;AAMa,MAAA,uBAAA,GAA0B,oBAAoB,IAAK,CAAA;AAAA,EAC9D,IAAM,EAAA,eAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA,gBAAA;AAAA,IACR,MAAQ,EAAA,MACN,OAAO,6BAAsB,CAAE,CAAA,IAAA,CAAK,CAAK,CAAA,qBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,MAAA,EAAF,EAAS,IAAA,EAAK,SAAQ,CAAE,CAAA;AAAA,GACtE;AACF,CAAC,EAAA;AAKY,MAAA,+BAAA,GACX,oBAAoB,iBAAkB,CAAA;AAAA,EACpC,IAAM,EAAA,qBAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,KAAA,EAAO,CACL,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,QACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,OACpC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,KACjB;AAAA,GACF;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAU,EAAA;AACnC,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,MAAQ,EAAA,gBAAA;AAAA,MACR,MAAQ,EAAA,YACN,OAAO,kCAAqB,EAAE,IAAK,CAAA,CAAA,CAAA,qBAChC,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,qBAAF,EAAA,EAAyB,GAAG,MAAA,CAAO,OAAO,CAC5C,CAAA;AAAA,KACJ,CAAA,CAAA;AAAA,GACH;AACF,CAAC,EAAA;AAKU,MAAA,sCAAA,GACX,oBAAoB,iBAAkB,CAAA;AAAA,EACpC,IAAM,EAAA,6BAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,KAAA,EAAO,CACL,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,QACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,OACpC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,KACjB;AAAA,GACF;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAU,EAAA;AACnC,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,MAAQ,EAAA,gBAAA;AAAA,MACR,MAAQ,EAAA,YACN,OAAO,kCAAqB,EAAE,IAAK,CAAA,CAAA,CAAA,qBAChC,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,4BAAF,EAAA,EAAgC,GAAG,MAAA,CAAO,OAAO,CACnD,CAAA;AAAA,KACJ,CAAA,CAAA;AAAA,GACH;AACF,CAAC,EAAA;AAKU,MAAA,iCAAA,GACX,oBAAoB,iBAAkB,CAAA;AAAA,EACpC,IAAM,EAAA,sBAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,KAAA,EAAO,CACL,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,QACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,QACnC,KAAO,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,KAAK,CAAA;AAAA,QAChC,OAAO,CAAE,CAAA,MAAA,GAAS,OAAQ,CAAA,CAAC,EAAE,QAAS,EAAA;AAAA,OACvC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,KACjB;AAAA,GACF;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAU,EAAA;AACnC,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,MAAQ,EAAA,gBAAA;AAAA,MACR,MAAQ,EAAA,YACN,OAAO,kCAAqB,EAAE,IAAK,CAAA,CAAA,CAAA,qBAChC,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,sBAAF,EAAA,EAA0B,GAAG,MAAA,CAAO,OAAO,CAC7C,CAAA;AAAA,KACJ,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
+{"version":3,"file":"entityCards.esm.js","sources":["../../src/alpha/entityCards.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport React from 'react';\nimport { EntityCardBlueprint } from '@backstage/plugin-catalog-react/alpha';\n\n/**\n * @alpha\n */\nexport const entityGithubActionsCard = EntityCardBlueprint.make({\n  name: 'workflow-runs',\n  params: {\n    filter: 'kind:component',\n    loader: () =>\n      import('../components/Router').then(m => <m.Router view=\"cards\" />),\n  },\n});\n\n/**\n * @alpha\n */\nexport const entityLatestGithubActionRunCard =\n  EntityCardBlueprint.makeWithOverrides({\n    name: 'latest-workflow-run',\n    config: {\n      schema: {\n        props: z =>\n          z\n            .object({\n              branch: z.string().default('master'),\n            })\n            .default({}),\n      },\n    },\n    factory(originalFactory, { config }) {\n      return originalFactory({\n        filter: 'kind:component',\n        loader: async () =>\n          import('../components/Cards').then(m => (\n            <m.LatestWorkflowRunCard {...config.props} />\n          )),\n      });\n    },\n  });\n\n/**\n * @alpha\n */\nexport const entityLatestGithubActionsForBranchCard =\n  EntityCardBlueprint.makeWithOverrides({\n    name: 'latest-branch-workflow-runs',\n    config: {\n      schema: {\n        props: z =>\n          z\n            .object({\n              branch: z.string().default('master'),\n            })\n            .default({}),\n      },\n    },\n    factory(originalFactory, { config }) {\n      return originalFactory({\n        filter: 'kind:component',\n        loader: async () =>\n          import('../components/Cards').then(m => (\n            <m.LatestWorkflowsForBranchCard {...config.props} />\n          )),\n      });\n    },\n  });\n\n/**\n * @alpha\n */\nexport const entityRecentGithubActionsRunsCard =\n  EntityCardBlueprint.makeWithOverrides({\n    name: 'recent-workflow-runs',\n    config: {\n      schema: {\n        props: z =>\n          z\n            .object({\n              branch: z.string().default('master'),\n              dense: z.boolean().default(false),\n              limit: z.number().default(5).optional(),\n            })\n            .default({}),\n      },\n    },\n    factory(originalFactory, { config }) {\n      return originalFactory({\n        filter: 'kind:component',\n        loader: async () =>\n          import('../components/Cards').then(m => (\n            <m.RecentWorkflowRunsCard {...config.props} />\n          )),\n      });\n    },\n  });\n"],"names":[],"mappings":";;;AAqBa,MAAA,uBAAA,GAA0B,oBAAoB,IAAK,CAAA;AAAA,EAC9D,IAAM,EAAA,eAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA,gBAAA;AAAA,IACR,MAAQ,EAAA,MACN,OAAO,6BAAsB,CAAE,CAAA,IAAA,CAAK,CAAK,CAAA,qBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,MAAA,EAAF,EAAS,IAAA,EAAK,SAAQ,CAAE,CAAA;AAAA,GACtE;AACF,CAAC,EAAA;AAKY,MAAA,+BAAA,GACX,oBAAoB,iBAAkB,CAAA;AAAA,EACpC,IAAM,EAAA,qBAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,KAAA,EAAO,CACL,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,QACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,OACpC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,KACjB;AAAA,GACF;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAU,EAAA;AACnC,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,MAAQ,EAAA,gBAAA;AAAA,MACR,MAAQ,EAAA,YACN,OAAO,kCAAqB,EAAE,IAAK,CAAA,CAAA,CAAA,qBAChC,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,qBAAF,EAAA,EAAyB,GAAG,MAAA,CAAO,OAAO,CAC5C,CAAA;AAAA,KACJ,CAAA,CAAA;AAAA,GACH;AACF,CAAC,EAAA;AAKU,MAAA,sCAAA,GACX,oBAAoB,iBAAkB,CAAA;AAAA,EACpC,IAAM,EAAA,6BAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,KAAA,EAAO,CACL,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,QACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,OACpC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,KACjB;AAAA,GACF;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAU,EAAA;AACnC,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,MAAQ,EAAA,gBAAA;AAAA,MACR,MAAQ,EAAA,YACN,OAAO,kCAAqB,EAAE,IAAK,CAAA,CAAA,CAAA,qBAChC,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,4BAAF,EAAA,EAAgC,GAAG,MAAA,CAAO,OAAO,CACnD,CAAA;AAAA,KACJ,CAAA,CAAA;AAAA,GACH;AACF,CAAC,EAAA;AAKU,MAAA,iCAAA,GACX,oBAAoB,iBAAkB,CAAA;AAAA,EACpC,IAAM,EAAA,sBAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,MAAQ,EAAA;AAAA,MACN,KAAA,EAAO,CACL,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,QACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,QACnC,KAAO,EAAA,CAAA,CAAE,OAAQ,EAAA,CAAE,QAAQ,KAAK,CAAA;AAAA,QAChC,OAAO,CAAE,CAAA,MAAA,GAAS,OAAQ,CAAA,CAAC,EAAE,QAAS,EAAA;AAAA,OACvC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,KACjB;AAAA,GACF;AAAA,EACA,OAAQ,CAAA,eAAA,EAAiB,EAAE,MAAA,EAAU,EAAA;AACnC,IAAA,OAAO,eAAgB,CAAA;AAAA,MACrB,MAAQ,EAAA,gBAAA;AAAA,MACR,MAAQ,EAAA,YACN,OAAO,kCAAqB,EAAE,IAAK,CAAA,CAAA,CAAA,qBAChC,KAAA,CAAA,aAAA,CAAA,CAAA,CAAE,sBAAF,EAAA,EAA0B,GAAG,MAAA,CAAO,OAAO,CAC7C,CAAA;AAAA,KACJ,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/alpha/entityContent.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"entityContent.esm.js","sources":["../../src/alpha/entityContent.tsx"],"sourcesContent":["import React from 'react';\nimport { convertLegacyRouteRef } from '@backstage/core-compat-api';\nimport { EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';\nimport { rootRouteRef } from '../routes';\n\n/**\n * @alpha\n */\nexport const entityGithubActionsContent = EntityContentBlueprint.make({\n  name: 'entity',\n  params: {\n    defaultPath: 'github-actions',\n    defaultTitle: 'GitHub Actions',\n    filter: 'kind:component',\n    routeRef: convertLegacyRouteRef(rootRouteRef),\n    loader: () =>\n      import('../components/Router').then(m => <m.Router view=\"table\" />),\n  },\n});\n"],"names":[],"mappings":";;;;;AAQa,MAAA,0BAAA,GAA6B,uBAAuB,IAAK,CAAA;AAAA,EACpE,IAAM,EAAA,QAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,WAAa,EAAA,gBAAA;AAAA,IACb,YAAc,EAAA,gBAAA;AAAA,IACd,MAAQ,EAAA,gBAAA;AAAA,IACR,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,MAAQ,EAAA,MACN,OAAO,6BAAsB,CAAE,CAAA,IAAA,CAAK,CAAK,CAAA,qBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,MAAA,EAAF,EAAS,IAAA,EAAK,SAAQ,CAAE,CAAA;AAAA,GACtE;AACF,CAAC;;;;"}
+{"version":3,"file":"entityContent.esm.js","sources":["../../src/alpha/entityContent.tsx"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport React from 'react';\nimport { convertLegacyRouteRef } from '@backstage/core-compat-api';\nimport { EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';\nimport { rootRouteRef } from '../routes';\n\n/**\n * @alpha\n */\nexport const entityGithubActionsContent = EntityContentBlueprint.make({\n  name: 'entity',\n  params: {\n    defaultPath: 'github-actions',\n    defaultTitle: 'GitHub Actions',\n    filter: 'kind:component',\n    routeRef: convertLegacyRouteRef(rootRouteRef),\n    loader: () =>\n      import('../components/Router').then(m => <m.Router view=\"table\" />),\n  },\n});\n"],"names":[],"mappings":";;;;;AAuBa,MAAA,0BAAA,GAA6B,uBAAuB,IAAK,CAAA;AAAA,EACpE,IAAM,EAAA,QAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,WAAa,EAAA,gBAAA;AAAA,IACb,YAAc,EAAA,gBAAA;AAAA,IACd,MAAQ,EAAA,gBAAA;AAAA,IACR,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,IAC5C,MAAQ,EAAA,MACN,OAAO,6BAAsB,CAAE,CAAA,IAAA,CAAK,CAAK,CAAA,qBAAA,KAAA,CAAA,aAAA,CAAC,CAAE,CAAA,MAAA,EAAF,EAAS,IAAA,EAAK,SAAQ,CAAE,CAAA;AAAA,GACtE;AACF,CAAC;;;;"}

package/dist/alpha.d.ts

@@ -7,127 +7,171 @@ import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api'
 /**
  * @alpha
  */
-declare const _default: _backstage_frontend_plugin_api.BackstagePlugin<{
+declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
     entityContent: _backstage_frontend_plugin_api.RouteRef<undefined>;
 }, {}, {
-    "api:github-actions": _backstage_frontend_plugin_api.ExtensionDefinition<{}, {}, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_core_plugin_api.AnyApiFactory, "core.api.factory", {}>, {}, {
+    "api:github-actions": _backstage_frontend_plugin_api.ExtensionDefinition<{
         kind: "api";
-        namespace: undefined;
         name: undefined;
+        config: {};
+        configInput: {};
+        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_core_plugin_api.AnyApiFactory, "core.api.factory", {}>;
+        inputs: {};
+        params: {
+            factory: _backstage_core_plugin_api.AnyApiFactory;
+        };
     }>;
     "entity-card:github-actions/workflow-runs": _backstage_frontend_plugin_api.ExtensionDefinition<{
-        filter: string | undefined;
-    }, {
-        filter?: string | undefined;
-    }, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
-        optional: true;
-    }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
-        optional: true;
-    }>, {}, {
         kind: "entity-card";
-        namespace: undefined;
         name: "workflow-runs";
+        config: {
+            filter: string | undefined;
+        };
+        configInput: {
+            filter?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
+            optional: true;
+        }>;
+        inputs: {};
+        params: {
+            loader: () => Promise<JSX.Element>;
+            filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
+        };
     }>;
     "entity-card:github-actions/latest-workflow-run": _backstage_frontend_plugin_api.ExtensionDefinition<{
-        props: {
-            branch: string;
-        };
-    } & {
-        filter: string | undefined;
-    }, {
-        props?: {
-            branch?: string | undefined;
-        } | undefined;
-    } & {
-        filter?: string | undefined;
-    }, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
-        optional: true;
-    }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
-        optional: true;
-    }>, {
-        [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
-            optional: boolean;
-            singleton: boolean;
+        config: {
+            props: {
+                branch: string;
+            };
+        } & {
+            filter: string | undefined;
+        };
+        configInput: {
+            props?: {
+                branch?: string | undefined;
+            } | undefined;
+        } & {
+            filter?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
+            optional: true;
         }>;
-    }, {
+        inputs: {
+            [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
+                optional: boolean;
+                singleton: boolean;
+            }>;
+        };
         kind: "entity-card";
-        namespace: undefined;
         name: "latest-workflow-run";
+        params: {
+            loader: () => Promise<JSX.Element>;
+            filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
+        };
     }>;
     "entity-card:github-actions/latest-branch-workflow-runs": _backstage_frontend_plugin_api.ExtensionDefinition<{
-        props: {
-            branch: string;
-        };
-    } & {
-        filter: string | undefined;
-    }, {
-        props?: {
-            branch?: string | undefined;
-        } | undefined;
-    } & {
-        filter?: string | undefined;
-    }, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
-        optional: true;
-    }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
-        optional: true;
-    }>, {
-        [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
-            optional: boolean;
-            singleton: boolean;
+        config: {
+            props: {
+                branch: string;
+            };
+        } & {
+            filter: string | undefined;
+        };
+        configInput: {
+            props?: {
+                branch?: string | undefined;
+            } | undefined;
+        } & {
+            filter?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
+            optional: true;
         }>;
-    }, {
+        inputs: {
+            [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
+                optional: boolean;
+                singleton: boolean;
+            }>;
+        };
         kind: "entity-card";
-        namespace: undefined;
         name: "latest-branch-workflow-runs";
+        params: {
+            loader: () => Promise<JSX.Element>;
+            filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
+        };
     }>;
     "entity-card:github-actions/recent-workflow-runs": _backstage_frontend_plugin_api.ExtensionDefinition<{
-        props: {
-            dense: boolean;
-            branch: string;
-            limit?: number | undefined;
-        };
-    } & {
-        filter: string | undefined;
-    }, {
-        props?: {
-            dense?: boolean | undefined;
-            branch?: string | undefined;
-            limit?: number | undefined;
-        } | undefined;
-    } & {
-        filter?: string | undefined;
-    }, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
-        optional: true;
-    }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
-        optional: true;
-    }>, {
-        [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
-            optional: boolean;
-            singleton: boolean;
+        config: {
+            props: {
+                dense: boolean;
+                branch: string;
+                limit?: number | undefined;
+            };
+        } & {
+            filter: string | undefined;
+        };
+        configInput: {
+            props?: {
+                dense?: boolean | undefined;
+                branch?: string | undefined;
+                limit?: number | undefined;
+            } | undefined;
+        } & {
+            filter?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
+            optional: true;
         }>;
-    }, {
+        inputs: {
+            [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
+                optional: boolean;
+                singleton: boolean;
+            }>;
+        };
         kind: "entity-card";
-        namespace: undefined;
         name: "recent-workflow-runs";
+        params: {
+            loader: () => Promise<JSX.Element>;
+            filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
+        };
     }>;
     "entity-content:github-actions/entity": _backstage_frontend_plugin_api.ExtensionDefinition<{
-        path: string | undefined;
-        title: string | undefined;
-        filter: string | undefined;
-    }, {
-        filter?: string | undefined;
-        title?: string | undefined;
-        path?: string | undefined;
-    }, _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
-        optional: true;
-    }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
-        optional: true;
-    }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
-        optional: true;
-    }>, {}, {
         kind: "entity-content";
-        namespace: undefined;
         name: "entity";
+        config: {
+            path: string | undefined;
+            title: string | undefined;
+            filter: string | undefined;
+        };
+        configInput: {
+            filter?: string | undefined;
+            title?: string | undefined;
+            path?: string | undefined;
+        };
+        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
+            optional: true;
+        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
+            optional: true;
+        }>;
+        inputs: {};
+        params: {
+            loader: () => Promise<JSX.Element>;
+            defaultPath: string;
+            defaultTitle: string;
+            routeRef?: _backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams> | undefined;
+            filter?: string | ((entity: _backstage_catalog_model.Entity) => boolean) | undefined;
+        };
     }>;
 }>;
 

package/dist/alpha.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.ts"],"sourcesContent":["import { convertLegacyRouteRefs } from '@backstage/core-compat-api';\nimport { createFrontendPlugin } from '@backstage/frontend-plugin-api';\nimport {\n  entityGithubActionsCard,\n  entityGithubActionsContent,\n  entityLatestGithubActionRunCard,\n  entityLatestGithubActionsForBranchCard,\n  entityRecentGithubActionsRunsCard,\n  githubActionsApi,\n} from './alpha/index';\nimport { rootRouteRef } from './routes';\n\n/**\n * @alpha\n */\nexport default createFrontendPlugin({\n  id: 'github-actions',\n  routes: convertLegacyRouteRefs({\n    entityContent: rootRouteRef,\n  }),\n  extensions: [\n    entityGithubActionsContent,\n    entityGithubActionsCard,\n    entityLatestGithubActionRunCard,\n    entityLatestGithubActionsForBranchCard,\n    entityRecentGithubActionsRunsCard,\n    githubActionsApi,\n  ],\n});\n"],"names":[],"mappings":";;;;;;;AAeA,YAAe,oBAAqB,CAAA;AAAA,EAClC,EAAI,EAAA,gBAAA;AAAA,EACJ,QAAQ,sBAAuB,CAAA;AAAA,IAC7B,aAAe,EAAA,YAAA;AAAA,GAChB,CAAA;AAAA,EACD,UAAY,EAAA;AAAA,IACV,0BAAA;AAAA,IACA,uBAAA;AAAA,IACA,+BAAA;AAAA,IACA,sCAAA;AAAA,IACA,iCAAA;AAAA,IACA,gBAAA;AAAA,GACF;AACF,CAAC,CAAA;;;;"}
+{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { convertLegacyRouteRefs } from '@backstage/core-compat-api';\nimport { createFrontendPlugin } from '@backstage/frontend-plugin-api';\nimport {\n  entityGithubActionsCard,\n  entityGithubActionsContent,\n  entityLatestGithubActionRunCard,\n  entityLatestGithubActionsForBranchCard,\n  entityRecentGithubActionsRunsCard,\n  githubActionsApi,\n} from './alpha/index';\nimport { rootRouteRef } from './routes';\n\n/**\n * @alpha\n */\nexport default createFrontendPlugin({\n  id: 'github-actions',\n  routes: convertLegacyRouteRefs({\n    entityContent: rootRouteRef,\n  }),\n  extensions: [\n    entityGithubActionsContent,\n    entityGithubActionsCard,\n    entityLatestGithubActionRunCard,\n    entityLatestGithubActionsForBranchCard,\n    entityRecentGithubActionsRunsCard,\n    githubActionsApi,\n  ],\n});\n"],"names":[],"mappings":";;;;;;;AA8BA,YAAe,oBAAqB,CAAA;AAAA,EAClC,EAAI,EAAA,gBAAA;AAAA,EACJ,QAAQ,sBAAuB,CAAA;AAAA,IAC7B,aAAe,EAAA,YAAA;AAAA,GAChB,CAAA;AAAA,EACD,UAAY,EAAA;AAAA,IACV,0BAAA;AAAA,IACA,uBAAA;AAAA,IACA,+BAAA;AAAA,IACA,sCAAA;AAAA,IACA,iCAAA;AAAA,IACA,gBAAA;AAAA,GACF;AACF,CAAC,CAAA;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-github-actions",
-  "version": "0.6.22",
+  "version": "0.6.24",
   "description": "A Backstage plugin that integrates towards GitHub Actions",
   "backstage": {
     "role": "frontend-plugin",
@@ -19,6 +19,7 @@
       "default": "./dist/index.esm.js"
     },
     "./alpha": {
+      "backstage": "@backstage/FrontendPlugin",
       "import": "./dist/alpha.esm.js",
       "types": "./dist/alpha.d.ts",
       "default": "./dist/alpha.esm.js"
@@ -54,14 +55,14 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^1.6.0",
-    "@backstage/core-compat-api": "^0.2.8",
-    "@backstage/core-components": "^0.14.10",
-    "@backstage/core-plugin-api": "^1.9.3",
-    "@backstage/frontend-plugin-api": "^0.7.0",
-    "@backstage/integration": "^1.14.0",
-    "@backstage/integration-react": "^1.1.30",
-    "@backstage/plugin-catalog-react": "^1.12.3",
+    "@backstage/catalog-model": "^1.7.0",
+    "@backstage/core-compat-api": "^0.3.1",
+    "@backstage/core-components": "^0.15.1",
+    "@backstage/core-plugin-api": "^1.10.0",
+    "@backstage/frontend-plugin-api": "^0.9.0",
+    "@backstage/integration": "^1.15.1",
+    "@backstage/integration-react": "^1.2.0",
+    "@backstage/plugin-catalog-react": "^1.14.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -72,11 +73,11 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.27.0",
-    "@backstage/core-app-api": "^1.14.2",
-    "@backstage/dev-utils": "^1.0.37",
-    "@backstage/frontend-test-utils": "^0.1.12",
-    "@backstage/test-utils": "^1.5.10",
+    "@backstage/cli": "^0.28.0",
+    "@backstage/core-app-api": "^1.15.1",
+    "@backstage/dev-utils": "^1.1.2",
+    "@backstage/frontend-test-utils": "^0.2.1",
+    "@backstage/test-utils": "^1.7.0",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0",