fix(github-actions): use default branch of repository for latest builds where branch unspecified instead of assuming master (#4636)

* fix(github-actions): use repo default branch instead of assuming master

Signed-off-by: Robin Hilton <[email protected]>

* expand to include feedback from PR and also update Alpha UI to remove default of master

Signed-off-by: Robin Hilton <[email protected]>

* remove superfluous lines that are unused

Signed-off-by: Robin Hilton <[email protected]>

* attempt to resolve CI errors

Signed-off-by: Robin Hilton <[email protected]>

* remove superfluous lines that are unused

Signed-off-by: Robin Hilton <[email protected]>

* remove superfluous lines that are unused

Signed-off-by: Robin Hilton <[email protected]>

* Fix linting issue

Signed-off-by: Robin Hilton <[email protected]>

* force run prettier over the file

Signed-off-by: Robin Hilton <[email protected]>

* Fix CI issue around report-alpha.api.md

Signed-off-by: Robin Hilton <[email protected]>

* Fix CI issue around report-alpha.api.md

Signed-off-by: Robin Hilton <[email protected]>

* update test suite to match new ui expectation

Signed-off-by: Robin Hilton <[email protected]>

---------

Signed-off-by: Robin Hilton <[email protected]>
Signed-off-by: Robin Hilton <[email protected]>
Co-authored-by: Robin Hilton <[email protected]>

Author: 22367rh

workspaces/github-actions/.changeset/gold-rules-burn.md

@@ -0,0 +1,5 @@
+---
+'@backstage-community/plugin-github-actions': patch
+---
+
+Change default branch to be that of the target repository instead of assuming it is using master.

workspaces/github-actions/plugins/github-actions/report-alpha.api.md

@@ -45,7 +45,7 @@ const _default: FrontendPlugin<
     ]: ExtensionDefinition<{
       config: {
         props: {
-          branch: string;
+          branch?: string | undefined;
         };
       } & {
         filter: EntityPredicate | undefined;
@@ -104,7 +104,7 @@ const _default: FrontendPlugin<
     [x: `entity-card:${string}/latest-workflow-run`]: ExtensionDefinition<{
       config: {
         props: {
-          branch: string;
+          branch?: string | undefined;
         };
       } & {
         filter: EntityPredicate | undefined;
@@ -164,7 +164,7 @@ const _default: FrontendPlugin<
       config: {
         props: {
           dense: boolean;
-          branch: string;
+          branch?: string | undefined;
           limit?: number | undefined;
         };
       } & {

workspaces/github-actions/plugins/github-actions/src/alpha/entityCards.test.tsx

@@ -76,7 +76,7 @@ describe('Entity card extensions', () => {
 
     await waitFor(
       () => {
-        expect(screen.getByText('Last master build')).toBeInTheDocument();
+        expect(screen.getByText('Last main build')).toBeInTheDocument();
       },
       { timeout: 5000 },
     );
@@ -95,7 +95,7 @@ describe('Entity card extensions', () => {
 
     await waitFor(
       () => {
-        expect(screen.getByText('Last master build')).toBeInTheDocument();
+        expect(screen.getByText('Recent main builds')).toBeInTheDocument();
       },
       { timeout: 5000 },
     );

workspaces/github-actions/plugins/github-actions/src/alpha/entityCards.tsx

@@ -39,7 +39,7 @@ export const entityLatestGithubActionRunCard =
         props: z =>
           z
             .object({
-              branch: z.string().default('master'),
+              branch: z.string().optional(),
             })
             .default({}),
       },
@@ -66,7 +66,7 @@ export const entityLatestGithubActionsForBranchCard =
         props: z =>
           z
             .object({
-              branch: z.string().default('master'),
+              branch: z.string().optional(),
             })
             .default({}),
       },
@@ -93,7 +93,7 @@ export const entityRecentGithubActionsRunsCard =
         props: z =>
           z
             .object({
-              branch: z.string().default('master'),
+              branch: z.string().optional(),
               dense: z.boolean().default(false),
               limit: z.number().default(5).optional(),
             })

workspaces/github-actions/plugins/github-actions/src/components/Cards/Cards.tsx

@@ -32,6 +32,7 @@ import {
   StructuredMetadataTable,
 } from '@backstage/core-components';
 import { getHostnameFromEntity } from '../getHostnameFromEntity';
+import { useDefaultBranch } from '../useDefaultBranch';
 import Box from '@material-ui/core/Box';
 
 const useStyles = makeStyles({
@@ -45,7 +46,7 @@ const WidgetContent = (props: {
   error?: Error;
   loading?: boolean;
   lastRun: WorkflowRun;
-  branch: string;
+  branch?: string;
 }) => {
   const { error, loading, lastRun, branch } = props;
   const classes = useStyles();
@@ -81,13 +82,19 @@ export const LatestWorkflowRunCard = (props: {
   branch?: string;
   variant?: InfoCardVariants;
 }) => {
-  const { branch = 'master', variant } = props;
+  const { variant } = props;
   const { entity } = useEntity();
   const errorApi = useApi(errorApiRef);
   const hostname = getHostnameFromEntity(entity);
   const [owner, repo] = (
     entity?.metadata.annotations?.[GITHUB_ACTIONS_ANNOTATION] ?? '/'
   ).split('/');
+  const defaultBranch = useDefaultBranch({
+    hostname,
+    owner,
+    repo,
+  }).branch;
+  const branch = props.branch ?? defaultBranch;
   const [{ runs, loading, error }] = useWorkflowRuns({
     hostname,
     owner,
@@ -119,11 +126,21 @@ export const LatestWorkflowsForBranchCard = (props: {
   branch?: string;
   variant?: InfoCardVariants;
 }) => {
-  const { branch = 'master', variant } = props;
+  const { variant } = props;
   const { entity } = useEntity();
+  const hostname = getHostnameFromEntity(entity);
+  const [owner, repo] = (
+    entity?.metadata.annotations?.[GITHUB_ACTIONS_ANNOTATION] ?? '/'
+  ).split('/');
+  const defaultBranch = useDefaultBranch({
+    hostname,
+    owner,
+    repo,
+  }).branch;
+  const branch = props.branch ?? defaultBranch;
 
   return (
-    <InfoCard title={`Last ${branch} build`} variant={variant}>
+    <InfoCard title={`Recent ${branch} builds`} variant={variant}>
       <WorkflowRunsTable branch={branch} entity={entity} />
     </InfoCard>
   );

workspaces/github-actions/plugins/github-actions/src/components/useDefaultBranch.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import useAsyncRetry from 'react-use/esm/useAsyncRetry';
+import { githubActionsApiRef } from '../api/GithubActionsApi';
+import { useApi } from '@backstage/core-plugin-api';
+
+export function useDefaultBranch({
+  hostname,
+  owner,
+  repo,
+}: {
+  hostname?: string;
+  owner: string;
+  repo: string;
+}) {
+  const api = useApi(githubActionsApiRef);
+
+  const { value, loading, error } = useAsyncRetry<string>(async () => {
+    return api.getDefaultBranch({
+      hostname,
+      owner,
+      repo,
+    });
+  }, [api]);
+
+  return {
+    branch: value,
+    loading,
+    error,
+  };
+}