@backstage-community/plugin-cicd-statistics-module-github 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @backstage-community/plugin-cicd-statistics-module-github
+
+## 0.2.0
+
+### Minor Changes
+
+- 84e88ce: New cicd-satistics for querying github actions metrics

package/README.md

@@ -0,0 +1,42 @@
+# cicd-statistics-module-github
+
+This is an extension module to the `cicd-statistics` plugin, providing a `CicdStatisticsApiGithub` that you can use to extract the CI/CD statistics from your Github repository.
+
+## Getting started
+
+1. Install the `cicd-statistics` and `cicd-statistics-module-github` plugins in the `app` package.
+
+2. Configure your ApiFactory:
+   - You can optionally pass in a third argument to `CicdStatisticsApiGithub` of type [CicdDefaults](https://github.com/backstage/backstage/blob/2881c53cb383bf127c150f837f37fe535d8cf97b/plugins/cicd-statistics/src/apis/types.ts#L179) to alter the default CICD UI configuration
+
+```tsx
+// packages/app/src/apis.ts
+import { githubAuthApiRef } from '@backstage/core-plugin-api';
+
+import { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';
+import { CicdStatisticsApiGithub } from '@backstage-community/plugin-cicd-statistics-module-github';
+
+export const apis: AnyApiFactory[] = [
+  createApiFactory({
+    api: cicdStatisticsApiRef,
+    deps: {
+      githubAuthApi: githubAuthApiRef,
+      configApi: configApiRef,
+    },
+    factory: ({ githubAuthApi, configApi }) => {
+      return new CicdStatisticsApiGithub(githubAuthApi, configApi);
+    },
+  }),
+];
+```
+
+3. Add the component to your EntityPage:
+
+```tsx
+// packages/app/src/components/catalog/EntityPage.tsx
+import { EntityCicdStatisticsContent } from '@backstage-community/plugin-cicd-statistics';
+
+<EntityLayout.Route path="/ci-cd-statistics" title="CI/CD Statistics">
+  <EntityCicdStatisticsContent />
+</EntityLayout.Route>;
+```

package/dist/alpha.d.ts

@@ -0,0 +1,23 @@
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+import * as _backstage_core_plugin_api__ from '@backstage/core-plugin-api/*';
+
+/**
+ * @alpha
+ */
+declare const cicdStatisticsGithubExtension: _backstage_frontend_plugin_api.ExtensionDefinition<{
+    kind: "api";
+    name: "cicd-statistics-github-api";
+    config: {};
+    configInput: {};
+    output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_core_plugin_api__.AnyApiFactory, "core.api.factory", {}>;
+    inputs: {};
+    params: {
+        factory: _backstage_core_plugin_api__.AnyApiFactory;
+    };
+}>;
+/**
+ * @alpha
+ */
+declare const cicdStatisticsExtensionOverrides: _backstage_frontend_plugin_api.FrontendModule;
+
+export { cicdStatisticsGithubExtension, cicdStatisticsExtensionOverrides as default };

package/dist/alpha.esm.js

@@ -0,0 +1,26 @@
+import { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';
+import { ApiBlueprint, createApiFactory, githubAuthApiRef, configApiRef, createFrontendModule } from '@backstage/frontend-plugin-api';
+import { CicdStatisticsApiGithub } from './api/github.esm.js';
+
+const cicdStatisticsGithubExtension = ApiBlueprint.make({
+  name: "cicd-statistics-github-api",
+  params: {
+    factory: createApiFactory({
+      api: cicdStatisticsApiRef,
+      deps: {
+        githubAuthApi: githubAuthApiRef,
+        configApi: configApiRef
+      },
+      factory: ({ githubAuthApi, configApi }) => {
+        return new CicdStatisticsApiGithub(githubAuthApi, configApi);
+      }
+    })
+  }
+});
+const cicdStatisticsExtensionOverrides = createFrontendModule({
+  pluginId: "cicd-statistics",
+  extensions: [cicdStatisticsGithubExtension]
+});
+
+export { cicdStatisticsGithubExtension, cicdStatisticsExtensionOverrides as default };
+//# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -0,0 +1 @@
+{"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 { cicdStatisticsApiRef } from '@backstage-community/plugin-cicd-statistics';\nimport {\n  ApiBlueprint,\n  configApiRef,\n  createApiFactory,\n  createFrontendModule,\n  githubAuthApiRef,\n} from '@backstage/frontend-plugin-api';\nimport { CicdStatisticsApiGithub } from './api';\n\n/**\n * @alpha\n */\nexport const cicdStatisticsGithubExtension = ApiBlueprint.make({\n  name: 'cicd-statistics-github-api',\n  params: {\n    factory: createApiFactory({\n      api: cicdStatisticsApiRef,\n      deps: {\n        githubAuthApi: githubAuthApiRef,\n        configApi: configApiRef,\n      },\n      factory: ({ githubAuthApi, configApi }) => {\n        return new CicdStatisticsApiGithub(githubAuthApi, configApi);\n      },\n    }),\n  },\n});\n\n/**\n * @alpha\n */\nconst cicdStatisticsExtensionOverrides = createFrontendModule({\n  pluginId: 'cicd-statistics',\n  extensions: [cicdStatisticsGithubExtension],\n});\n\nexport default cicdStatisticsExtensionOverrides;\n"],"names":[],"mappings":";;;;AA4Ba,MAAA,6BAAA,GAAgC,aAAa,IAAK,CAAA;AAAA,EAC7D,IAAM,EAAA,4BAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,SAAS,gBAAiB,CAAA;AAAA,MACxB,GAAK,EAAA,oBAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,aAAe,EAAA,gBAAA;AAAA,QACf,SAAW,EAAA;AAAA,OACb;AAAA,MACA,OAAS,EAAA,CAAC,EAAE,aAAA,EAAe,WAAgB,KAAA;AACzC,QAAO,OAAA,IAAI,uBAAwB,CAAA,aAAA,EAAe,SAAS,CAAA;AAAA;AAC7D,KACD;AAAA;AAEL,CAAC;AAKD,MAAM,mCAAmC,oBAAqB,CAAA;AAAA,EAC5D,QAAU,EAAA,iBAAA;AAAA,EACV,UAAA,EAAY,CAAC,6BAA6B;AAC5C,CAAC;;;;"}

package/dist/api/github.esm.js

@@ -0,0 +1,119 @@
+import limiterFactory from 'p-limit';
+import { getEntitySourceLocation } from '@backstage/catalog-model';
+import { jobToStages, workflowToBuild } from './utils.esm.js';
+import { readGithubIntegrationConfigs } from '@backstage/integration';
+import { Octokit } from '@octokit/rest';
+
+const GITHUB_ACTIONS_ANNOTATION = "github.com/project-slug";
+const getProjectNameFromEntity = (entity) => entity?.metadata.annotations?.[GITHUB_ACTIONS_ANNOTATION] ?? "";
+class CicdStatisticsApiGithub {
+  #githubAuthApi;
+  #cicdDefaults;
+  configApi;
+  constructor(githubAuthApi, configApi, cicdDefaults = {}) {
+    this.#githubAuthApi = githubAuthApi;
+    this.#cicdDefaults = cicdDefaults;
+    this.configApi = configApi;
+  }
+  async createGithubApi(entity, scopes) {
+    const entityInfo = getEntitySourceLocation(entity);
+    const [owner, repo] = getProjectNameFromEntity(entity).split("/");
+    const url = new URL(entityInfo.target);
+    const oauthToken = await this.#githubAuthApi.getAccessToken(scopes);
+    const configs = readGithubIntegrationConfigs(
+      this.configApi.getOptionalConfigArray("integrations.github") ?? []
+    );
+    const githubIntegrationConfig = configs.find((v) => v.host === url.hostname);
+    const baseUrl = githubIntegrationConfig?.apiBaseUrl;
+    return {
+      api: new Octokit({ auth: oauthToken, baseUrl }),
+      owner,
+      repo
+    };
+  }
+  static async updateBuildWithStages(octokit, owner, repo, build) {
+    const jobs = await octokit.actions.listJobsForWorkflowRun({
+      repo,
+      owner,
+      run_id: parseInt(build.id, 10)
+    });
+    const stages = jobs.data.jobs.map(jobToStages);
+    return stages;
+  }
+  static async getDurationOfBuild(octokit, owner, repo, build) {
+    const workflow = await octokit.actions.getWorkflowRunUsage({
+      owner,
+      repo,
+      run_id: parseInt(build.id, 10)
+    });
+    return workflow.data?.run_duration_ms ?? 0;
+  }
+  static async getDefaultBranch(octokit, owner, repo) {
+    const repository = await octokit.repos.get({
+      owner,
+      repo
+    });
+    return repository.data.default_branch;
+  }
+  async fetchBuilds(options) {
+    const {
+      entity,
+      updateProgress,
+      timeFrom,
+      timeTo,
+      filterStatus = ["all"],
+      filterType = "all"
+    } = options;
+    const { api, owner, repo } = await this.createGithubApi(entity, [
+      "read_api"
+    ]);
+    updateProgress(0, 0, 0);
+    const branch = filterType === "master" ? await CicdStatisticsApiGithub.getDefaultBranch(api, owner, repo) : void 0;
+    const workflowsRuns = await api.paginate(
+      api.actions.listWorkflowRunsForRepo,
+      {
+        owner,
+        repo,
+        per_page: 1e3,
+        // max items per page
+        ...branch ? { branch } : {},
+        created: `${timeFrom.toISOString()}..${timeTo.toISOString()}`
+        // see https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates
+      },
+      (response) => response.data.map(workflowToBuild)
+    );
+    const limiter = limiterFactory(10);
+    const builds = workflowsRuns.map(async (build) => ({
+      ...build,
+      duration: await limiter(
+        () => CicdStatisticsApiGithub.getDurationOfBuild(api, owner, repo, build)
+      ),
+      stages: await limiter(
+        () => CicdStatisticsApiGithub.updateBuildWithStages(api, owner, repo, build)
+      )
+    }));
+    const promisedBuilds = (await Promise.all(builds)).filter(
+      (b) => filterStatus.includes(b.status)
+    );
+    return { builds: promisedBuilds };
+  }
+  async getConfiguration() {
+    return {
+      availableStatuses: [
+        "succeeded",
+        "running",
+        "aborted",
+        "failed",
+        "unknown",
+        "stalled",
+        "expired",
+        "enqueued",
+        "scheduled"
+      ],
+      defaults: this.#cicdDefaults
+    };
+  }
+}
+
+export { CicdStatisticsApiGithub, GITHUB_ACTIONS_ANNOTATION, getProjectNameFromEntity };
+//# sourceMappingURL=github.esm.js.map

package/dist/api/github.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"github.esm.js","sources":["../../src/api/github.ts"],"sourcesContent":["/*\n * Copyright 2022 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 */\n\nimport {\n  CicdStatisticsApi,\n  CicdState,\n  CicdConfiguration,\n  CicdDefaults,\n  Build,\n  FetchBuildsOptions,\n  Stage,\n} from '@backstage-community/plugin-cicd-statistics';\nimport { ConfigApi, OAuthApi } from '@backstage/core-plugin-api';\nimport limiterFactory from 'p-limit';\nimport { Entity, getEntitySourceLocation } from '@backstage/catalog-model';\nimport { jobToStages, workflowToBuild } from './utils';\n\nimport { readGithubIntegrationConfigs } from '@backstage/integration';\nimport { Octokit } from '@octokit/rest';\n\n/** @public */\nexport const GITHUB_ACTIONS_ANNOTATION = 'github.com/project-slug';\n\nexport const getProjectNameFromEntity = (entity: Entity) =>\n  entity?.metadata.annotations?.[GITHUB_ACTIONS_ANNOTATION] ?? '';\n\n/**\n * This type represents a initialized github client with octokit\n *\n * @public\n */\nexport type GithubClient = {\n  /* the actual API of octokit */\n  api: InstanceType<typeof Octokit>;\n  /* the owner the repository, retrieved from the entity source location  */\n  owner: string;\n  /* the repository name, retrieved from the entity source location  */\n  repo: string;\n};\n\n/**\n * Extracts the CI/CD statistics from a Github repository\n *\n * @public\n */\nexport class CicdStatisticsApiGithub implements CicdStatisticsApi {\n  readonly #githubAuthApi: OAuthApi;\n  readonly #cicdDefaults: Partial<CicdDefaults>;\n  readonly configApi: ConfigApi;\n\n  constructor(\n    githubAuthApi: OAuthApi,\n    configApi: ConfigApi,\n    cicdDefaults: Partial<CicdDefaults> = {},\n  ) {\n    this.#githubAuthApi = githubAuthApi;\n    this.#cicdDefaults = cicdDefaults;\n    this.configApi = configApi;\n  }\n\n  public async createGithubApi(\n    entity: Entity,\n    scopes: string[],\n  ): Promise<GithubClient> {\n    const entityInfo = getEntitySourceLocation(entity);\n    const [owner, repo] = getProjectNameFromEntity(entity).split('/');\n    const url = new URL(entityInfo.target);\n    const oauthToken = await this.#githubAuthApi.getAccessToken(scopes);\n\n    const configs = readGithubIntegrationConfigs(\n      this.configApi.getOptionalConfigArray('integrations.github') ?? [],\n    );\n    const githubIntegrationConfig = configs.find(v => v.host === url.hostname);\n    const baseUrl = githubIntegrationConfig?.apiBaseUrl;\n    return {\n      api: new Octokit({ auth: oauthToken, baseUrl }),\n      owner,\n      repo,\n    };\n  }\n\n  private static async updateBuildWithStages(\n    octokit: InstanceType<typeof Octokit>,\n    owner: string,\n    repo: string,\n    build: Build,\n  ): Promise<Stage[]> {\n    const jobs = await octokit.actions.listJobsForWorkflowRun({\n      repo,\n      owner,\n      run_id: parseInt(build.id, 10),\n    });\n    const stages = jobs.data.jobs.map(jobToStages);\n    return stages;\n  }\n\n  private static async getDurationOfBuild(\n    octokit: InstanceType<typeof Octokit>,\n    owner: string,\n    repo: string,\n    build: Build,\n  ): Promise<number> {\n    const workflow = await octokit.actions.getWorkflowRunUsage({\n      owner,\n      repo,\n      run_id: parseInt(build.id, 10),\n    });\n    return workflow.data?.run_duration_ms ?? 0;\n  }\n\n  private static async getDefaultBranch(\n    octokit: InstanceType<typeof Octokit>,\n    owner: string,\n    repo: string,\n  ): Promise<string | undefined> {\n    const repository = await octokit.repos.get({\n      owner,\n      repo,\n    });\n    return repository.data.default_branch;\n  }\n\n  public async fetchBuilds(options: FetchBuildsOptions): Promise<CicdState> {\n    const {\n      entity,\n      updateProgress,\n      timeFrom,\n      timeTo,\n      filterStatus = ['all'],\n      filterType = 'all',\n    } = options;\n    const { api, owner, repo } = await this.createGithubApi(entity, [\n      'read_api',\n    ]);\n    updateProgress(0, 0, 0);\n\n    const branch =\n      filterType === 'master'\n        ? await CicdStatisticsApiGithub.getDefaultBranch(api, owner, repo)\n        : undefined;\n\n    const workflowsRuns = await api.paginate(\n      api.actions.listWorkflowRunsForRepo,\n      {\n        owner,\n        repo,\n        per_page: 1000, // max items per page\n        ...(branch ? { branch } : {}),\n        created: `${timeFrom.toISOString()}..${timeTo.toISOString()}`, // see https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates\n      },\n      response => response.data.map(workflowToBuild),\n    );\n\n    const limiter = limiterFactory(10);\n    const builds = workflowsRuns.map(async build => ({\n      ...build,\n      duration: await limiter(() =>\n        CicdStatisticsApiGithub.getDurationOfBuild(api, owner, repo, build),\n      ),\n      stages: await limiter(() =>\n        CicdStatisticsApiGithub.updateBuildWithStages(api, owner, repo, build),\n      ),\n    }));\n    const promisedBuilds = (await Promise.all(builds)).filter(b =>\n      filterStatus.includes(b.status),\n    );\n\n    return { builds: promisedBuilds };\n  }\n\n  public async getConfiguration(): Promise<Partial<CicdConfiguration>> {\n    return {\n      availableStatuses: [\n        'succeeded',\n        'running',\n        'aborted',\n        'failed',\n        'unknown',\n        'stalled',\n        'expired',\n        'enqueued',\n        'scheduled',\n      ] as const,\n      defaults: this.#cicdDefaults,\n    };\n  }\n}\n"],"names":[],"mappings":";;;;;;AAkCO,MAAM,yBAA4B,GAAA;AAElC,MAAM,2BAA2B,CAAC,MAAA,KACvC,QAAQ,QAAS,CAAA,WAAA,GAAc,yBAAyB,CAAK,IAAA;AAqBxD,MAAM,uBAAqD,CAAA;AAAA,EACvD,cAAA;AAAA,EACA,aAAA;AAAA,EACA,SAAA;AAAA,EAET,WACE,CAAA,aAAA,EACA,SACA,EAAA,YAAA,GAAsC,EACtC,EAAA;AACA,IAAA,IAAA,CAAK,cAAiB,GAAA,aAAA;AACtB,IAAA,IAAA,CAAK,aAAgB,GAAA,YAAA;AACrB,IAAA,IAAA,CAAK,SAAY,GAAA,SAAA;AAAA;AACnB,EAEA,MAAa,eACX,CAAA,MAAA,EACA,MACuB,EAAA;AACvB,IAAM,MAAA,UAAA,GAAa,wBAAwB,MAAM,CAAA;AACjD,IAAM,MAAA,CAAC,OAAO,IAAI,CAAA,GAAI,yBAAyB,MAAM,CAAA,CAAE,MAAM,GAAG,CAAA;AAChE,IAAA,MAAM,GAAM,GAAA,IAAI,GAAI,CAAA,UAAA,CAAW,MAAM,CAAA;AACrC,IAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,cAAA,CAAe,eAAe,MAAM,CAAA;AAElE,IAAA,MAAM,OAAU,GAAA,4BAAA;AAAA,MACd,IAAK,CAAA,SAAA,CAAU,sBAAuB,CAAA,qBAAqB,KAAK;AAAC,KACnE;AACA,IAAA,MAAM,0BAA0B,OAAQ,CAAA,IAAA,CAAK,OAAK,CAAE,CAAA,IAAA,KAAS,IAAI,QAAQ,CAAA;AACzE,IAAA,MAAM,UAAU,uBAAyB,EAAA,UAAA;AACzC,IAAO,OAAA;AAAA,MACL,KAAK,IAAI,OAAA,CAAQ,EAAE,IAAM,EAAA,UAAA,EAAY,SAAS,CAAA;AAAA,MAC9C,KAAA;AAAA,MACA;AAAA,KACF;AAAA;AACF,EAEA,aAAqB,qBAAA,CACnB,OACA,EAAA,KAAA,EACA,MACA,KACkB,EAAA;AAClB,IAAA,MAAM,IAAO,GAAA,MAAM,OAAQ,CAAA,OAAA,CAAQ,sBAAuB,CAAA;AAAA,MACxD,IAAA;AAAA,MACA,KAAA;AAAA,MACA,MAAQ,EAAA,QAAA,CAAS,KAAM,CAAA,EAAA,EAAI,EAAE;AAAA,KAC9B,CAAA;AACD,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,IAAK,CAAA,IAAA,CAAK,IAAI,WAAW,CAAA;AAC7C,IAAO,OAAA,MAAA;AAAA;AACT,EAEA,aAAqB,kBAAA,CACnB,OACA,EAAA,KAAA,EACA,MACA,KACiB,EAAA;AACjB,IAAA,MAAM,QAAW,GAAA,MAAM,OAAQ,CAAA,OAAA,CAAQ,mBAAoB,CAAA;AAAA,MACzD,KAAA;AAAA,MACA,IAAA;AAAA,MACA,MAAQ,EAAA,QAAA,CAAS,KAAM,CAAA,EAAA,EAAI,EAAE;AAAA,KAC9B,CAAA;AACD,IAAO,OAAA,QAAA,CAAS,MAAM,eAAmB,IAAA,CAAA;AAAA;AAC3C,EAEA,aAAqB,gBAAA,CACnB,OACA,EAAA,KAAA,EACA,IAC6B,EAAA;AAC7B,IAAA,MAAM,UAAa,GAAA,MAAM,OAAQ,CAAA,KAAA,CAAM,GAAI,CAAA;AAAA,MACzC,KAAA;AAAA,MACA;AAAA,KACD,CAAA;AACD,IAAA,OAAO,WAAW,IAAK,CAAA,cAAA;AAAA;AACzB,EAEA,MAAa,YAAY,OAAiD,EAAA;AACxE,IAAM,MAAA;AAAA,MACJ,MAAA;AAAA,MACA,cAAA;AAAA,MACA,QAAA;AAAA,MACA,MAAA;AAAA,MACA,YAAA,GAAe,CAAC,KAAK,CAAA;AAAA,MACrB,UAAa,GAAA;AAAA,KACX,GAAA,OAAA;AACJ,IAAM,MAAA,EAAE,KAAK,KAAO,EAAA,IAAA,KAAS,MAAM,IAAA,CAAK,gBAAgB,MAAQ,EAAA;AAAA,MAC9D;AAAA,KACD,CAAA;AACD,IAAe,cAAA,CAAA,CAAA,EAAG,GAAG,CAAC,CAAA;AAEtB,IAAM,MAAA,MAAA,GACJ,eAAe,QACX,GAAA,MAAM,wBAAwB,gBAAiB,CAAA,GAAA,EAAK,KAAO,EAAA,IAAI,CAC/D,GAAA,KAAA,CAAA;AAEN,IAAM,MAAA,aAAA,GAAgB,MAAM,GAAI,CAAA,QAAA;AAAA,MAC9B,IAAI,OAAQ,CAAA,uBAAA;AAAA,MACZ;AAAA,QACE,KAAA;AAAA,QACA,IAAA;AAAA,QACA,QAAU,EAAA,GAAA;AAAA;AAAA,QACV,GAAI,MAAA,GAAS,EAAE,MAAA,KAAW,EAAC;AAAA,QAC3B,OAAA,EAAS,GAAG,QAAS,CAAA,WAAA,EAAa,CAAK,EAAA,EAAA,MAAA,CAAO,aAAa,CAAA;AAAA;AAAA,OAC7D;AAAA,MACA,CAAY,QAAA,KAAA,QAAA,CAAS,IAAK,CAAA,GAAA,CAAI,eAAe;AAAA,KAC/C;AAEA,IAAM,MAAA,OAAA,GAAU,eAAe,EAAE,CAAA;AACjC,IAAA,MAAM,MAAS,GAAA,aAAA,CAAc,GAAI,CAAA,OAAM,KAAU,MAAA;AAAA,MAC/C,GAAG,KAAA;AAAA,MACH,UAAU,MAAM,OAAA;AAAA,QAAQ,MACtB,uBAAwB,CAAA,kBAAA,CAAmB,GAAK,EAAA,KAAA,EAAO,MAAM,KAAK;AAAA,OACpE;AAAA,MACA,QAAQ,MAAM,OAAA;AAAA,QAAQ,MACpB,uBAAwB,CAAA,qBAAA,CAAsB,GAAK,EAAA,KAAA,EAAO,MAAM,KAAK;AAAA;AACvE,KACA,CAAA,CAAA;AACF,IAAA,MAAM,cAAkB,GAAA,CAAA,MAAM,OAAQ,CAAA,GAAA,CAAI,MAAM,CAAG,EAAA,MAAA;AAAA,MAAO,CACxD,CAAA,KAAA,YAAA,CAAa,QAAS,CAAA,CAAA,CAAE,MAAM;AAAA,KAChC;AAEA,IAAO,OAAA,EAAE,QAAQ,cAAe,EAAA;AAAA;AAClC,EAEA,MAAa,gBAAwD,GAAA;AACnE,IAAO,OAAA;AAAA,MACL,iBAAmB,EAAA;AAAA,QACjB,WAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,QAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,SAAA;AAAA,QACA,UAAA;AAAA,QACA;AAAA,OACF;AAAA,MACA,UAAU,IAAK,CAAA;AAAA,KACjB;AAAA;AAEJ;;;;"}

package/dist/api/utils.esm.js

@@ -0,0 +1,56 @@
+const statusMap = {
+  // completed, action_required, cancelled, failure, neutral, skipped, stale, success, timed_out, in_progress, queued, requested, waiting, pending
+  completed: "succeeded",
+  action_required: "running",
+  cancelled: "aborted",
+  failure: "failed",
+  neutral: "unknown",
+  skipped: "aborted",
+  stale: "stalled",
+  success: "succeeded",
+  timed_out: "expired",
+  in_progress: "running",
+  queued: "enqueued",
+  requested: "scheduled",
+  waiting: "running",
+  pending: "running"
+};
+const triggerEventMap = {
+  push: "scm",
+  workflow_dispatch: "manual",
+  pull_request: "scm",
+  schedule: "internal",
+  deployment: "scm",
+  dynamic: "internal"
+};
+function workflowToBuild(workflow) {
+  return {
+    id: workflow.id.toString(),
+    status: statusMap[workflow.conclusion ?? ""] ?? "unknown",
+    branchType: ["main", "master"].includes(workflow.head_branch ?? "") ? "master" : "branch",
+    duration: 0,
+    // will get filled in later in a separate API call
+    requestedAt: new Date(workflow.created_at),
+    triggeredBy: triggerEventMap[workflow.event] ?? "other",
+    stages: []
+  };
+}
+function jobToStages(job) {
+  const status = statusMap[job.status] ? statusMap[job.status] : "unknown";
+  const duration = job.started_at && job.completed_at ? new Date(job.completed_at).getTime() - new Date(job.started_at).getTime() : 0;
+  return {
+    name: job.name,
+    status,
+    duration,
+    stages: job.steps?.map((step) => {
+      return {
+        name: step.name,
+        status: statusMap[step.status] ?? "unknown",
+        duration: step.started_at && step.completed_at ? new Date(step.completed_at).getTime() - new Date(step.started_at).getTime() : 0
+      };
+    })
+  };
+}
+
+export { jobToStages, workflowToBuild };
+//# sourceMappingURL=utils.esm.js.map

package/dist/api/utils.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.esm.js","sources":["../../src/api/utils.ts"],"sourcesContent":["/*\n * Copyright 2022 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 */\n\nimport {\n  Build,\n  FilterStatusType,\n  TriggerReason,\n  Stage,\n} from '@backstage-community/plugin-cicd-statistics';\n\nimport { RestEndpointMethodTypes } from '@octokit/rest';\n\n// \"unknown\" | \"enqueued\" | \"scheduled\" | \"running\" | \"aborted\" | \"succeeded\" | \"failed\" | \"stalled\" | \"expired\"\n//\nconst statusMap: Record<string, FilterStatusType> = {\n  // completed, action_required, cancelled, failure, neutral, skipped, stale, success, timed_out, in_progress, queued, requested, waiting, pending\n\n  completed: 'succeeded',\n  action_required: 'running',\n  cancelled: 'aborted',\n  failure: 'failed',\n  neutral: 'unknown',\n  skipped: 'aborted',\n  stale: 'stalled',\n  success: 'succeeded',\n  timed_out: 'expired',\n  in_progress: 'running',\n  queued: 'enqueued',\n  requested: 'scheduled',\n  waiting: 'running',\n  pending: 'running',\n};\n\n// see https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows\nconst triggerEventMap: Record<string, TriggerReason> = {\n  push: 'scm',\n  workflow_dispatch: 'manual',\n  pull_request: 'scm',\n  schedule: 'internal',\n  deployment: 'scm',\n  dynamic: 'internal',\n};\n\n/**\n * Takes the Workflow object from Github and transforms it to the Build object\n *\n * @param workflow - Workflow object that gets returned from Github\n *\n * @public\n */\nexport function workflowToBuild(\n  workflow: RestEndpointMethodTypes['actions']['listWorkflowRuns']['response']['data']['workflow_runs'][0],\n): Build {\n  return {\n    id: workflow.id.toString(),\n    status: statusMap[workflow.conclusion ?? ''] ?? 'unknown',\n    branchType: ['main', 'master'].includes(workflow.head_branch ?? '')\n      ? 'master'\n      : 'branch',\n    duration: 0, // will get filled in later in a separate API call\n    requestedAt: new Date(workflow.created_at),\n    triggeredBy: triggerEventMap[workflow.event] ?? 'other',\n    stages: [],\n  };\n}\n\n/**\n * Takes the Job object from Github and transforms it to the Stage object\n *\n * @param jobs - Job object that gets returned from Github\n *\n * @public\n *\n * @remarks\n *\n */\nexport function jobToStages(\n  job: RestEndpointMethodTypes['actions']['listJobsForWorkflowRun']['response']['data']['jobs'][0],\n): Stage {\n  const status = statusMap[job.status] ? statusMap[job.status] : 'unknown';\n  const duration =\n    job.started_at && job.completed_at\n      ? new Date(job.completed_at).getTime() -\n        new Date(job.started_at).getTime()\n      : 0;\n  return {\n    name: job.name,\n    status,\n    duration,\n    stages: job.steps?.map(step => {\n      return {\n        name: step.name,\n        status: statusMap[step.status] ?? 'unknown',\n        duration:\n          step.started_at && step.completed_at\n            ? new Date(step.completed_at).getTime() -\n              new Date(step.started_at).getTime()\n            : 0,\n      };\n    }),\n  };\n}\n"],"names":[],"mappings":"AA2BA,MAAM,SAA8C,GAAA;AAAA;AAAA,EAGlD,SAAW,EAAA,WAAA;AAAA,EACX,eAAiB,EAAA,SAAA;AAAA,EACjB,SAAW,EAAA,SAAA;AAAA,EACX,OAAS,EAAA,QAAA;AAAA,EACT,OAAS,EAAA,SAAA;AAAA,EACT,OAAS,EAAA,SAAA;AAAA,EACT,KAAO,EAAA,SAAA;AAAA,EACP,OAAS,EAAA,WAAA;AAAA,EACT,SAAW,EAAA,SAAA;AAAA,EACX,WAAa,EAAA,SAAA;AAAA,EACb,MAAQ,EAAA,UAAA;AAAA,EACR,SAAW,EAAA,WAAA;AAAA,EACX,OAAS,EAAA,SAAA;AAAA,EACT,OAAS,EAAA;AACX,CAAA;AAGA,MAAM,eAAiD,GAAA;AAAA,EACrD,IAAM,EAAA,KAAA;AAAA,EACN,iBAAmB,EAAA,QAAA;AAAA,EACnB,YAAc,EAAA,KAAA;AAAA,EACd,QAAU,EAAA,UAAA;AAAA,EACV,UAAY,EAAA,KAAA;AAAA,EACZ,OAAS,EAAA;AACX,CAAA;AASO,SAAS,gBACd,QACO,EAAA;AACP,EAAO,OAAA;AAAA,IACL,EAAA,EAAI,QAAS,CAAA,EAAA,CAAG,QAAS,EAAA;AAAA,IACzB,MAAQ,EAAA,SAAA,CAAU,QAAS,CAAA,UAAA,IAAc,EAAE,CAAK,IAAA,SAAA;AAAA,IAChD,UAAA,EAAY,CAAC,MAAA,EAAQ,QAAQ,CAAA,CAAE,SAAS,QAAS,CAAA,WAAA,IAAe,EAAE,CAAA,GAC9D,QACA,GAAA,QAAA;AAAA,IACJ,QAAU,EAAA,CAAA;AAAA;AAAA,IACV,WAAa,EAAA,IAAI,IAAK,CAAA,QAAA,CAAS,UAAU,CAAA;AAAA,IACzC,WAAa,EAAA,eAAA,CAAgB,QAAS,CAAA,KAAK,CAAK,IAAA,OAAA;AAAA,IAChD,QAAQ;AAAC,GACX;AACF;AAYO,SAAS,YACd,GACO,EAAA;AACP,EAAM,MAAA,MAAA,GAAS,UAAU,GAAI,CAAA,MAAM,IAAI,SAAU,CAAA,GAAA,CAAI,MAAM,CAAI,GAAA,SAAA;AAC/D,EAAA,MAAM,WACJ,GAAI,CAAA,UAAA,IAAc,IAAI,YAClB,GAAA,IAAI,KAAK,GAAI,CAAA,YAAY,CAAE,CAAA,OAAA,KAC3B,IAAI,IAAA,CAAK,IAAI,UAAU,CAAA,CAAE,SACzB,GAAA,CAAA;AACN,EAAO,OAAA;AAAA,IACL,MAAM,GAAI,CAAA,IAAA;AAAA,IACV,MAAA;AAAA,IACA,QAAA;AAAA,IACA,MAAQ,EAAA,GAAA,CAAI,KAAO,EAAA,GAAA,CAAI,CAAQ,IAAA,KAAA;AAC7B,MAAO,OAAA;AAAA,QACL,MAAM,IAAK,CAAA,IAAA;AAAA,QACX,MAAQ,EAAA,SAAA,CAAU,IAAK,CAAA,MAAM,CAAK,IAAA,SAAA;AAAA,QAClC,UACE,IAAK,CAAA,UAAA,IAAc,KAAK,YACpB,GAAA,IAAI,KAAK,IAAK,CAAA,YAAY,CAAE,CAAA,OAAA,KAC5B,IAAI,IAAA,CAAK,KAAK,UAAU,CAAA,CAAE,SAC1B,GAAA;AAAA,OACR;AAAA,KACD;AAAA,GACH;AACF;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { CicdStatisticsApi, CicdDefaults, FetchBuildsOptions, CicdState, CicdConfiguration } from '@backstage-community/plugin-cicd-statistics';
+import { ConfigApi, OAuthApi } from '@backstage/core-plugin-api';
+import { Entity } from '@backstage/catalog-model';
+import { Octokit } from '@octokit/rest';
+
+/**
+ * This type represents a initialized github client with octokit
+ *
+ * @public
+ */
+type GithubClient = {
+    api: InstanceType<typeof Octokit>;
+    owner: string;
+    repo: string;
+};
+/**
+ * Extracts the CI/CD statistics from a Github repository
+ *
+ * @public
+ */
+declare class CicdStatisticsApiGithub implements CicdStatisticsApi {
+    #private;
+    readonly configApi: ConfigApi;
+    constructor(githubAuthApi: OAuthApi, configApi: ConfigApi, cicdDefaults?: Partial<CicdDefaults>);
+    createGithubApi(entity: Entity, scopes: string[]): Promise<GithubClient>;
+    private static updateBuildWithStages;
+    private static getDurationOfBuild;
+    private static getDefaultBranch;
+    fetchBuilds(options: FetchBuildsOptions): Promise<CicdState>;
+    getConfiguration(): Promise<Partial<CicdConfiguration>>;
+}
+
+export { CicdStatisticsApiGithub, type GithubClient };

package/dist/index.esm.js

@@ -0,0 +1,2 @@
+export { CicdStatisticsApiGithub } from './api/github.esm.js';
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@backstage-community/plugin-cicd-statistics-module-github",
+  "version": "0.2.0",
+  "description": "CI/CD Statistics plugin module; Github CICD",
+  "backstage": {
+    "role": "frontend-plugin-module",
+    "pluginId": "cicd-statistics",
+    "pluginPackage": "@backstage-community/plugin-cicd-statistics",
+    "features": {
+      "./alpha": "@backstage/FrontendModule"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "backstage",
+    "cicd statistics",
+    "github"
+  ],
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/cicd-statistics/plugins/cicd-statistics-module-github"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.esm.js"
+    },
+    "./alpha": {
+      "backstage": "@backstage/FrontendModule",
+      "import": "./dist/alpha.esm.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.esm.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ],
+      "alpha": [
+        "dist/alpha.d.ts"
+      ]
+    }
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "main": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
+  },
+  "dependencies": {
+    "@backstage-community/plugin-cicd-statistics": "^0.5.0",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/core-plugin-api": "^1.10.4",
+    "@backstage/frontend-plugin-api": "^0.9.5",
+    "@backstage/integration": "^1.16.1",
+    "@octokit/rest": "^21.1.1",
+    "p-limit": "^3.1.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.30.0",
+    "@backstage/dev-utils": "^1.1.7",
+    "@backstage/integration": "^1.16.1",
+    "@backstage/plugin-catalog": "^1.27.0",
+    "@backstage/plugin-catalog-react": "^1.15.2",
+    "@types/react": "^16.13.1 || ^17.0.0",
+    "@types/react-dom": "^18.2.19",
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
+  },
+  "peerDependencies": {
+    "react": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
+    "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
+  },
+  "module": "./dist/index.esm.js"
+}