@backstage-community/plugin-github-actions 0.6.16

package/README.md

@@ -0,0 +1,110 @@
+# GitHub Actions Plugin
+
+Website: [https://github.com/actions](https://github.com/actions)
+
+## Screenshots
+
+TBD
+
+## Setup
+
+### 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`.
+   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:
+
+   The annotation key is `github.com/project-slug`.
+
+   Example:
+
+   ```yaml
+   apiVersion: backstage.io/v1alpha1
+   kind: Component
+   metadata:
+     name: backstage
+     description: backstage.io
+     annotations:
+       github.com/project-slug: 'backstage/backstage'
+   spec:
+     type: website
+     lifecycle: production
+     owner: user:guest
+   ```
+
+### Standalone app requirements
+
+1. Install the plugin dependency in your Backstage app package:
+
+```bash
+# From your Backstage root directory
+yarn --cwd packages/app add @backstage-community/plugin-github-actions
+```
+
+2. Add to the app `EntityPage` component:
+
+```tsx
+// In packages/app/src/components/catalog/EntityPage.tsx
+import {
+  EntityGithubActionsContent,
+  isGithubActionsAvailable,
+} from '@backstage-community/plugin-github-actions';
+
+// You can add the tab to any number of pages, the service page is shown as an
+// example here
+const serviceEntityPage = (
+  <EntityLayout>
+    {/* other tabs... */}
+    <EntityLayout.Route path="/github-actions" title="GitHub Actions">
+      <EntityGithubActionsContent />
+    </EntityLayout.Route>
+```
+
+3. Run the app with `yarn start` and the backend with `yarn start-backend`.
+   Then navigate to `/github-actions/` under any entity.
+
+### Self-hosted / Enterprise GitHub
+
+The plugin will try to use `backstage.io/source-location` or `backstage.io/managed-by-location`
+annotations to figure out the location of the source code.
+
+1. Add the `host` and `apiBaseUrl` to your `app-config.yaml`
+
+```yaml
+# app-config.yaml
+
+integrations:
+  github:
+    - host: 'your-github-host.com'
+      apiBaseUrl: 'https://api.your-github-host.com'
+```
+
+## Features
+
+- List workflow runs for a project
+- Dive into one run to see a job steps
+- Retry runs
+- Pagination for runs
+
+## 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
+
+Github Workflow Runs optional UI to show in Card view instead of table, with branch selection option
+
+```tsx
+
+// You can add the tab to any number of pages, the service page is shown as an
+// example given here
+const serviceEntityPage = (
+  <EntityLayout>
+    {/* other tabs... */}
+    <EntityLayout.Route path="/github-actions" title="GitHub Actions">
+      <EntityGithubActionsContent view='cards' />
+    </EntityLayout.Route>
+```

package/dist/esm/index-CRpdBPJi.esm.js

@@ -0,0 +1,50 @@
+export { LatestWorkflowRunCard, LatestWorkflowsForBranchCard, RecentWorkflowRunsCard } from '../index.esm.js';
+import '@backstage/core-plugin-api';
+import '@backstage/integration';
+import '@octokit/rest';
+import '@backstage/integration-react';
+import 'react';
+import '@backstage/plugin-catalog-react';
+import 'react-router-dom';
+import '@material-ui/core/Accordion';
+import '@material-ui/core/AccordionDetails';
+import '@material-ui/core/AccordionSummary';
+import '@material-ui/core/Box';
+import '@material-ui/core/CircularProgress';
+import '@material-ui/core/LinearProgress';
+import '@material-ui/core/ListItemText';
+import '@material-ui/core/Paper';
+import '@material-ui/core/Table';
+import '@material-ui/core/TableBody';
+import '@material-ui/core/TableCell';
+import '@material-ui/core/TableContainer';
+import '@material-ui/core/TableRow';
+import '@material-ui/core/Typography';
+import '@material-ui/core/styles';
+import '@material-ui/icons/ExpandMore';
+import '@material-ui/icons/Launch';
+import 'luxon';
+import '@backstage/core-components';
+import 'react-use/esm/useAsync';
+import '@material-ui/core/Fade';
+import '@material-ui/core/Modal';
+import '@material-ui/core/Tooltip';
+import '@material-ui/core/Zoom';
+import '@material-ui/icons/Description';
+import '@backstage/catalog-model';
+import 'git-url-parse';
+import '@material-ui/core/IconButton';
+import '@material-ui/core/Button';
+import '@material-ui/core/Chip';
+import '@material-ui/core/ButtonGroup';
+import '@material-ui/core/Grid';
+import '@material-ui/core/TablePagination';
+import '@material-ui/core/Select';
+import '@material-ui/core/MenuItem';
+import '@material-ui/core/TextField';
+import '@material-ui/icons/GitHub';
+import '@material-ui/icons/Replay';
+import '@material-ui/icons/Sync';
+import 'react-use/esm/useAsyncRetry';
+import '@material-ui/lab/Alert';
+//# sourceMappingURL=index-CRpdBPJi.esm.js.map

package/dist/esm/index-CRpdBPJi.esm.js.map

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

package/dist/index.d.ts

@@ -0,0 +1,236 @@
+/// <reference types="react" />
+import * as _backstage_core_components from '@backstage/core-components';
+import { InfoCardVariants } from '@backstage/core-components';
+import * as react from 'react';
+import react__default from 'react';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+import { ConfigApi } from '@backstage/core-plugin-api';
+import { RestEndpointMethodTypes } from '@octokit/rest';
+import { ScmAuthApi } from '@backstage/integration-react';
+import { Entity } from '@backstage/catalog-model';
+
+/** @public */
+declare const githubActionsApiRef: _backstage_core_plugin_api.ApiRef<GithubActionsApi>;
+/**
+ * A client for fetching information about GitHub actions.
+ *
+ * @public
+ */
+type GithubActionsApi = {
+    listWorkflowRuns: (options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        pageSize?: number;
+        page?: number;
+        branch?: string;
+    }) => Promise<RestEndpointMethodTypes['actions']['listWorkflowRuns']['response']['data']>;
+    getWorkflow: (options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+    }) => Promise<RestEndpointMethodTypes['actions']['getWorkflow']['response']['data']>;
+    getWorkflowRun: (options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+    }) => Promise<RestEndpointMethodTypes['actions']['getWorkflowRun']['response']['data']>;
+    reRunWorkflow: (options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        runId: number;
+    }) => Promise<any>;
+    listJobsForWorkflowRun: (options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+        pageSize?: number;
+        page?: number;
+    }) => Promise<RestEndpointMethodTypes['actions']['listJobsForWorkflowRun']['response']['data']>;
+    downloadJobLogsForWorkflowRun: (options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        runId: number;
+    }) => Promise<RestEndpointMethodTypes['actions']['downloadJobLogsForWorkflowRun']['response']['data']>;
+    listBranches: (options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        page: number;
+    }) => Promise<RestEndpointMethodTypes['repos']['listBranches']['response']['data']>;
+    getDefaultBranch: (options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+    }) => Promise<RestEndpointMethodTypes['repos']['get']['response']['data']['default_branch']>;
+};
+
+/**
+ * A client for fetching information about GitHub actions.
+ *
+ * @public
+ */
+declare class GithubActionsClient implements GithubActionsApi {
+    private readonly configApi;
+    private readonly scmAuthApi;
+    constructor(options: {
+        configApi: ConfigApi;
+        scmAuthApi: ScmAuthApi;
+    });
+    private getOctokit;
+    reRunWorkflow(options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        runId: number;
+    }): Promise<any>;
+    listWorkflowRuns(options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        pageSize?: number;
+        page?: number;
+        branch?: string;
+    }): Promise<RestEndpointMethodTypes['actions']['listWorkflowRuns']['response']['data']>;
+    getWorkflow(options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+    }): Promise<RestEndpointMethodTypes['actions']['getWorkflow']['response']['data']>;
+    getWorkflowRun(options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+    }): Promise<RestEndpointMethodTypes['actions']['getWorkflowRun']['response']['data']>;
+    listJobsForWorkflowRun(options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        id: number;
+        pageSize?: number;
+        page?: number;
+    }): Promise<RestEndpointMethodTypes['actions']['listJobsForWorkflowRun']['response']['data']>;
+    downloadJobLogsForWorkflowRun(options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        runId: number;
+    }): Promise<RestEndpointMethodTypes['actions']['downloadJobLogsForWorkflowRun']['response']['data']>;
+    listBranches(options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+        page?: number;
+    }): Promise<RestEndpointMethodTypes['repos']['listBranches']['response']['data']>;
+    getDefaultBranch(options: {
+        hostname?: string;
+        owner: string;
+        repo: string;
+    }): Promise<RestEndpointMethodTypes['repos']['get']['response']['data']['default_branch']>;
+}
+
+/** @public */
+type Step = {
+    name: string;
+    status: string;
+    conclusion?: string;
+    number: number;
+    started_at?: string;
+    completed_at?: string;
+};
+/** @public */
+type Job = {
+    html_url?: string;
+    status: string;
+    conclusion?: string;
+    started_at: string;
+    completed_at?: string;
+    id: number;
+    name: string;
+    steps?: Step[];
+};
+/** @public */
+type Jobs = {
+    total_count: number;
+    jobs: Job[];
+};
+/** @public */
+declare enum BuildStatus {
+    'success' = 0,
+    'failure' = 1,
+    'pending' = 2,
+    'running' = 3
+}
+/** @public */
+type Branch = {
+    name: string;
+};
+/** @public */
+type Branches = {
+    default_branch: string;
+    branches: Branch[];
+};
+/** @public */
+interface RouterProps {
+    view?: 'cards' | 'table';
+}
+
+/** @public */
+declare const githubActionsPlugin: _backstage_core_plugin_api.BackstagePlugin<{
+    entityContent: _backstage_core_plugin_api.RouteRef<undefined>;
+}, {}, {}>;
+/** @public */
+declare const EntityGithubActionsContent: (props: RouterProps) => react.JSX.Element;
+/** @public */
+declare const EntityLatestGithubActionRunCard: (props: {
+    branch: string;
+    variant?: _backstage_core_components.InfoCardVariants | undefined;
+}) => react.JSX.Element;
+/** @public */
+declare const EntityLatestGithubActionsForBranchCard: (props: {
+    branch: string;
+    variant?: _backstage_core_components.InfoCardVariants | undefined;
+}) => react.JSX.Element;
+/** @public */
+declare const EntityRecentGithubActionsRunsCard: (props: {
+    branch?: string | undefined;
+    dense?: boolean | undefined;
+    limit?: number | undefined;
+    variant?: _backstage_core_components.InfoCardVariants | undefined;
+}) => react.JSX.Element;
+
+/** @public */
+declare const isGithubActionsAvailable: (entity: Entity) => boolean;
+/** @public */
+declare const Router: (props: RouterProps) => react__default.JSX.Element;
+
+/** @public */
+declare const LatestWorkflowRunCard: (props: {
+    branch: string;
+    variant?: InfoCardVariants;
+}) => react__default.JSX.Element;
+/** @public */
+declare const LatestWorkflowsForBranchCard: (props: {
+    branch: string;
+    variant?: InfoCardVariants;
+}) => react__default.JSX.Element;
+
+/** @public */
+declare const RecentWorkflowRunsCard: (props: {
+    branch?: string;
+    dense?: boolean;
+    limit?: number;
+    variant?: InfoCardVariants;
+}) => react__default.JSX.Element;
+
+/** @public */
+declare const GITHUB_ACTIONS_ANNOTATION = "github.com/project-slug";
+
+export { type Branch, type Branches, BuildStatus, EntityGithubActionsContent, EntityLatestGithubActionRunCard, EntityLatestGithubActionsForBranchCard, EntityRecentGithubActionsRunsCard, GITHUB_ACTIONS_ANNOTATION, type GithubActionsApi, GithubActionsClient, type Job, type Jobs, LatestWorkflowRunCard, LatestWorkflowsForBranchCard, RecentWorkflowRunsCard, Router, type RouterProps, type Step, githubActionsApiRef, githubActionsPlugin, isGithubActionsAvailable, isGithubActionsAvailable as isPluginApplicableToEntity, githubActionsPlugin as plugin };