@backstage-community/plugin-github-actions 0.6.19 → 0.6.21

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage-community/plugin-github-actions
 
+## 0.6.21
+
+### Patch Changes
+
+- a0591d5: Make entity cards/content appear on Components only by default in new FE system
+
+## 0.6.20
+
+### Patch Changes
+
+- 8711599: Updating readmes in github actions to add configuration steps and removed incorrect limitations
+
 ## 0.6.19
 
 ### Patch Changes

package/README.md

@@ -27,8 +27,22 @@ TBD
 
 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`.
-   2. Take the Client ID and Client Secret from the newly created app's settings page and put them into `AUTH_GITHUB_CLIENT_ID` and `AUTH_GITHUB_CLIENT_SECRET` environment variables.
-2. Annotate your component with a correct GitHub Actions repository and owner:
+      **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
+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:
+
+   ```yaml
+   auth:
+     providers:
+       github:
+         development:
+           clientId: ${AUTH_GITHUB_CLIENT_ID}
+           clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
+   ```
+
+1. Annotate your component with a correct GitHub Actions repository and owner:
 
    The annotation key is `github.com/project-slug`.
 
@@ -101,7 +115,8 @@ export const app = createApp({
 });
 ```
 
-2. Next, enable your desired extensions in `app-config.yaml`
+2. Next, enable your desired extensions in `app-config.yaml`. By default, the content and cards will only appear on entities
+   that are Components. You can override that behavior here by adding a config block, demonstrated on the 'recent-workflow' card.
 
 ```yaml
 app:
@@ -109,7 +124,9 @@ app:
     - entity-content:github-actions/entity
     - entity-card:github-actions/latest-workflow-run
     - entity-card:github-actions/latest-branch-workflow-runs
-    - entity-card:github-actions/recent-workflow-runs
+    - entity-card:github-actions/recent-workflow-runs:
+        config:
+          filter: kind:component,api,group
 ```
 
 3. Whichever extensions you've enabled should now appear in your entity page.
@@ -140,8 +157,6 @@ integrations:
 ## Limitations
 
 - There is a limit of 100 apps for one OAuth client/token pair
-- The OAuth application must be at the GitHub organization level in order to display the workflows. If you do
-  not see any workflows, confirm the OAuth application was created in the organization and not a specific user account.
 
 ## Optional Workflow Runs Card View
 

package/alpha/package.json

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

package/dist/alpha/entityCards.esm.js

@@ -4,10 +4,12 @@ import { createEntityCardExtension } from '@backstage/plugin-catalog-react/alpha
 
 const entityGithubActionsCard = createEntityCardExtension({
   name: "workflow-runs",
+  filter: "kind:component",
   loader: () => import('../components/Router.esm.js').then((m) => /* @__PURE__ */ React.createElement(m.Router, { view: "cards" }))
 });
 const entityLatestGithubActionRunCard = createEntityCardExtension({
   name: "latest-workflow-run",
+  filter: "kind:component",
   configSchema: createSchemaFromZod(
     (z) => z.object({
       props: z.object({
@@ -21,6 +23,7 @@ const entityLatestGithubActionRunCard = createEntityCardExtension({
 const entityLatestGithubActionsForBranchCard = createEntityCardExtension(
   {
     name: "latest-branch-workflow-runs",
+    filter: "kind:component",
     configSchema: createSchemaFromZod(
       (z) => z.object({
         props: z.object({
@@ -34,6 +37,7 @@ const entityLatestGithubActionsForBranchCard = createEntityCardExtension(
 );
 const entityRecentGithubActionsRunsCard = createEntityCardExtension({
   name: "recent-workflow-runs",
+  filter: "kind:component",
   configSchema: createSchemaFromZod(
     (z) => z.object({
       props: z.object({

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 { createSchemaFromZod } from '@backstage/frontend-plugin-api';\nimport { createEntityCardExtension } from '@backstage/plugin-catalog-react/alpha';\n\n/**\n * @alpha\n */\nexport const entityGithubActionsCard = createEntityCardExtension({\n  name: 'workflow-runs',\n  loader: () =>\n    import('../components/Router').then(m => <m.Router view=\"cards\" />),\n});\n\n/**\n * @alpha\n */\nexport const entityLatestGithubActionRunCard = createEntityCardExtension({\n  name: 'latest-workflow-run',\n  configSchema: createSchemaFromZod(z =>\n    z.object({\n      props: z\n        .object({\n          branch: z.string().default('master'),\n        })\n        .default({}),\n      filter: z.string().optional(),\n    }),\n  ),\n  loader: ({ config }) =>\n    import('../components/Cards').then(m => (\n      <m.LatestWorkflowRunCard {...config.props} />\n    )),\n});\n\n/**\n * @alpha\n */\nexport const entityLatestGithubActionsForBranchCard = createEntityCardExtension(\n  {\n    name: 'latest-branch-workflow-runs',\n    configSchema: createSchemaFromZod(z =>\n      z.object({\n        props: z\n          .object({\n            branch: z.string().default('master'),\n          })\n          .default({}),\n        filter: z.string().optional(),\n      }),\n    ),\n    loader: ({ config }) =>\n      import('../components/Cards').then(m => (\n        <m.LatestWorkflowsForBranchCard {...config.props} />\n      )),\n  },\n);\n\n/**\n * @alpha\n */\nexport const entityRecentGithubActionsRunsCard = createEntityCardExtension({\n  name: 'recent-workflow-runs',\n  configSchema: createSchemaFromZod(z =>\n    z.object({\n      props: 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      filter: z.string().optional(),\n    }),\n  ),\n  loader: ({ config }) =>\n    import('../components/Cards').then(m => (\n      <m.RecentWorkflowRunsCard {...config.props} />\n    )),\n});\n"],"names":[],"mappings":";;;;AAOO,MAAM,0BAA0B,yBAA0B,CAAA;AAAA,EAC/D,IAAM,EAAA,eAAA;AAAA,EACN,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;AACtE,CAAC,EAAA;AAKM,MAAM,kCAAkC,yBAA0B,CAAA;AAAA,EACvE,IAAM,EAAA,qBAAA;AAAA,EACN,YAAc,EAAA,mBAAA;AAAA,IAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA,MACP,KAAA,EAAO,EACJ,MAAO,CAAA;AAAA,QACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,OACpC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,MACb,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,KAC7B,CAAA;AAAA,GACH;AAAA,EACA,QAAQ,CAAC,EAAE,MAAO,EAAA,KAChB,OAAO,kCAAqB,CAAA,CAAE,IAAK,CAAA,CAAA,CAAA,yCAChC,CAAE,CAAA,qBAAA,EAAF,EAAyB,GAAG,MAAA,CAAO,OAAO,CAC5C,CAAA;AACL,CAAC,EAAA;AAKM,MAAM,sCAAyC,GAAA,yBAAA;AAAA,EACpD;AAAA,IACE,IAAM,EAAA,6BAAA;AAAA,IACN,YAAc,EAAA,mBAAA;AAAA,MAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA,QACP,KAAA,EAAO,EACJ,MAAO,CAAA;AAAA,UACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,SACpC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,QACb,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,OAC7B,CAAA;AAAA,KACH;AAAA,IACA,QAAQ,CAAC,EAAE,MAAO,EAAA,KAChB,OAAO,kCAAqB,CAAA,CAAE,IAAK,CAAA,CAAA,CAAA,yCAChC,CAAE,CAAA,4BAAA,EAAF,EAAgC,GAAG,MAAA,CAAO,OAAO,CACnD,CAAA;AAAA,GACL;AACF,EAAA;AAKO,MAAM,oCAAoC,yBAA0B,CAAA;AAAA,EACzE,IAAM,EAAA,sBAAA;AAAA,EACN,YAAc,EAAA,mBAAA;AAAA,IAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA,MACP,KAAA,EAAO,EACJ,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,MACb,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,KAC7B,CAAA;AAAA,GACH;AAAA,EACA,QAAQ,CAAC,EAAE,MAAO,EAAA,KAChB,OAAO,kCAAqB,CAAA,CAAE,IAAK,CAAA,CAAA,CAAA,yCAChC,CAAE,CAAA,sBAAA,EAAF,EAA0B,GAAG,MAAA,CAAO,OAAO,CAC7C,CAAA;AACL,CAAC;;;;"}
+{"version":3,"file":"entityCards.esm.js","sources":["../../src/alpha/entityCards.tsx"],"sourcesContent":["import React from 'react';\nimport { createSchemaFromZod } from '@backstage/frontend-plugin-api';\nimport { createEntityCardExtension } from '@backstage/plugin-catalog-react/alpha';\n\n/**\n * @alpha\n */\nexport const entityGithubActionsCard = createEntityCardExtension({\n  name: 'workflow-runs',\n  filter: 'kind:component',\n  loader: () =>\n    import('../components/Router').then(m => <m.Router view=\"cards\" />),\n});\n\n/**\n * @alpha\n */\nexport const entityLatestGithubActionRunCard = createEntityCardExtension({\n  name: 'latest-workflow-run',\n  filter: 'kind:component',\n  configSchema: createSchemaFromZod(z =>\n    z.object({\n      props: z\n        .object({\n          branch: z.string().default('master'),\n        })\n        .default({}),\n      filter: z.string().optional(),\n    }),\n  ),\n  loader: ({ config }) =>\n    import('../components/Cards').then(m => (\n      <m.LatestWorkflowRunCard {...config.props} />\n    )),\n});\n\n/**\n * @alpha\n */\nexport const entityLatestGithubActionsForBranchCard = createEntityCardExtension(\n  {\n    name: 'latest-branch-workflow-runs',\n    filter: 'kind:component',\n    configSchema: createSchemaFromZod(z =>\n      z.object({\n        props: z\n          .object({\n            branch: z.string().default('master'),\n          })\n          .default({}),\n        filter: z.string().optional(),\n      }),\n    ),\n    loader: ({ config }) =>\n      import('../components/Cards').then(m => (\n        <m.LatestWorkflowsForBranchCard {...config.props} />\n      )),\n  },\n);\n\n/**\n * @alpha\n */\nexport const entityRecentGithubActionsRunsCard = createEntityCardExtension({\n  name: 'recent-workflow-runs',\n  filter: 'kind:component',\n  configSchema: createSchemaFromZod(z =>\n    z.object({\n      props: 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      filter: z.string().optional(),\n    }),\n  ),\n  loader: ({ config }) =>\n    import('../components/Cards').then(m => (\n      <m.RecentWorkflowRunsCard {...config.props} />\n    )),\n});\n"],"names":[],"mappings":";;;;AAOO,MAAM,0BAA0B,yBAA0B,CAAA;AAAA,EAC/D,IAAM,EAAA,eAAA;AAAA,EACN,MAAQ,EAAA,gBAAA;AAAA,EACR,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;AACtE,CAAC,EAAA;AAKM,MAAM,kCAAkC,yBAA0B,CAAA;AAAA,EACvE,IAAM,EAAA,qBAAA;AAAA,EACN,MAAQ,EAAA,gBAAA;AAAA,EACR,YAAc,EAAA,mBAAA;AAAA,IAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA,MACP,KAAA,EAAO,EACJ,MAAO,CAAA;AAAA,QACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,OACpC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,MACb,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,KAC7B,CAAA;AAAA,GACH;AAAA,EACA,QAAQ,CAAC,EAAE,MAAO,EAAA,KAChB,OAAO,kCAAqB,CAAA,CAAE,IAAK,CAAA,CAAA,CAAA,yCAChC,CAAE,CAAA,qBAAA,EAAF,EAAyB,GAAG,MAAA,CAAO,OAAO,CAC5C,CAAA;AACL,CAAC,EAAA;AAKM,MAAM,sCAAyC,GAAA,yBAAA;AAAA,EACpD;AAAA,IACE,IAAM,EAAA,6BAAA;AAAA,IACN,MAAQ,EAAA,gBAAA;AAAA,IACR,YAAc,EAAA,mBAAA;AAAA,MAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA,QACP,KAAA,EAAO,EACJ,MAAO,CAAA;AAAA,UACN,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAQ,QAAQ,CAAA;AAAA,SACpC,CAAA,CACA,OAAQ,CAAA,EAAE,CAAA;AAAA,QACb,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,OAC7B,CAAA;AAAA,KACH;AAAA,IACA,QAAQ,CAAC,EAAE,MAAO,EAAA,KAChB,OAAO,kCAAqB,CAAA,CAAE,IAAK,CAAA,CAAA,CAAA,yCAChC,CAAE,CAAA,4BAAA,EAAF,EAAgC,GAAG,MAAA,CAAO,OAAO,CACnD,CAAA;AAAA,GACL;AACF,EAAA;AAKO,MAAM,oCAAoC,yBAA0B,CAAA;AAAA,EACzE,IAAM,EAAA,sBAAA;AAAA,EACN,MAAQ,EAAA,gBAAA;AAAA,EACR,YAAc,EAAA,mBAAA;AAAA,IAAoB,CAAA,CAAA,KAChC,EAAE,MAAO,CAAA;AAAA,MACP,KAAA,EAAO,EACJ,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,MACb,MAAQ,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,QAAS,EAAA;AAAA,KAC7B,CAAA;AAAA,GACH;AAAA,EACA,QAAQ,CAAC,EAAE,MAAO,EAAA,KAChB,OAAO,kCAAqB,CAAA,CAAE,IAAK,CAAA,CAAA,CAAA,yCAChC,CAAE,CAAA,sBAAA,EAAF,EAA0B,GAAG,MAAA,CAAO,OAAO,CAC7C,CAAA;AACL,CAAC;;;;"}

package/dist/alpha/entityContent.esm.js

@@ -7,6 +7,7 @@ const entityGithubActionsContent = createEntityContentExtension({
   defaultPath: "github-actions",
   defaultTitle: "GitHub Actions",
   name: "entity",
+  filter: "kind:component",
   routeRef: convertLegacyRouteRef(rootRouteRef),
   loader: () => import('../components/Router.esm.js').then((m) => /* @__PURE__ */ React.createElement(m.Router, { view: "table" }))
 });

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 { createEntityContentExtension } from '@backstage/plugin-catalog-react/alpha';\nimport { rootRouteRef } from '../routes';\n\n/**\n * @alpha\n */\nexport const entityGithubActionsContent = createEntityContentExtension({\n  defaultPath: 'github-actions',\n  defaultTitle: 'GitHub Actions',\n  name: 'entity',\n  routeRef: convertLegacyRouteRef(rootRouteRef),\n  loader: () =>\n    import('../components/Router').then(m => <m.Router view=\"table\" />),\n});\n"],"names":[],"mappings":";;;;;AAQO,MAAM,6BAA6B,4BAA6B,CAAA;AAAA,EACrE,WAAa,EAAA,gBAAA;AAAA,EACb,YAAc,EAAA,gBAAA;AAAA,EACd,IAAM,EAAA,QAAA;AAAA,EACN,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,EAC5C,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;AACtE,CAAC;;;;"}
+{"version":3,"file":"entityContent.esm.js","sources":["../../src/alpha/entityContent.tsx"],"sourcesContent":["import React from 'react';\nimport { convertLegacyRouteRef } from '@backstage/core-compat-api';\nimport { createEntityContentExtension } from '@backstage/plugin-catalog-react/alpha';\nimport { rootRouteRef } from '../routes';\n\n/**\n * @alpha\n */\nexport const entityGithubActionsContent = createEntityContentExtension({\n  defaultPath: 'github-actions',\n  defaultTitle: 'GitHub Actions',\n  name: 'entity',\n  filter: 'kind:component',\n  routeRef: convertLegacyRouteRef(rootRouteRef),\n  loader: () =>\n    import('../components/Router').then(m => <m.Router view=\"table\" />),\n});\n"],"names":[],"mappings":";;;;;AAQO,MAAM,6BAA6B,4BAA6B,CAAA;AAAA,EACrE,WAAa,EAAA,gBAAA;AAAA,EACb,YAAc,EAAA,gBAAA;AAAA,EACd,IAAM,EAAA,QAAA;AAAA,EACN,MAAQ,EAAA,gBAAA;AAAA,EACR,QAAA,EAAU,sBAAsB,YAAY,CAAA;AAAA,EAC5C,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;AACtE,CAAC;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-github-actions",
-  "version": "0.6.19",
+  "version": "0.6.21",
   "description": "A Backstage plugin that integrates towards GitHub Actions",
   "backstage": {
     "role": "frontend-plugin",