Merge pull request #24082 from gilfthde/bugfix/commit-status-array

Fix `plugin-github-pull-requests-board` failing to render because commit status returned by GraphQL query is a list

.changeset/beige-worms-deny.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-github-pull-requests-board': minor
+---
+
+Fixed bug in CardHeader not expecting commit status as an array as returned by GraphQL

plugins/github-pull-requests-board/src/components/Card/Card.tsx

@@ -29,7 +29,7 @@ type Props = {
   isDraft: boolean;
   repositoryIsArchived: boolean;
   labels?: Label[];
-  status?: Status;
+  status?: Status[];
 };
 
 const Card: FunctionComponent<PropsWithChildren<Props>> = (

plugins/github-pull-requests-board/src/components/Card/CardHeader.test.tsx

@@ -37,13 +37,15 @@ const props = {
       name: 'documentation',
     },
   ],
-  status: {
-    commit: {
-      statusCheckRollup: {
-        state: 'SUCCESS',
+  status: [
+    {
+      commit: {
+        statusCheckRollup: {
+          state: 'SUCCESS',
+        },
       },
     },
-  },
+  ],
 };
 
 describe('<CardHeader/>', () => {
@@ -65,7 +67,7 @@ describe('<CardHeader/>', () => {
   it('finds commit status in PR Card Header', async () => {
     await renderInTestApp(<CardHeader {...props} />);
     expect(screen.getByText('Commit Status:')).toBeInTheDocument();
-    expect(props.status?.commit.statusCheckRollup.state).toBeTruthy();
+    expect(props.status[0].commit.statusCheckRollup.state).toBeTruthy();
   });
 
   it('does not find commit status in PR Card Header when PR does not include status', async () => {

plugins/github-pull-requests-board/src/components/Card/CardHeader.tsx

@@ -32,7 +32,7 @@ type Props = {
   isDraft: boolean;
   repositoryIsArchived: boolean;
   labels?: Label[];
-  status?: Status;
+  status?: Status[];
 };
 
 const CardHeader: FunctionComponent<Props> = (props: Props) => {
@@ -92,7 +92,9 @@ const CardHeader: FunctionComponent<Props> = (props: Props) => {
         <Box display="flex" alignItems="center" flexWrap="wrap" paddingTop={1}>
           <Typography variant="body2" component="p">
             Commit Status:{' '}
-            <strong>{status.commit.statusCheckRollup?.state || 'N/A'}</strong>
+            <strong>
+              {status[0]?.commit.statusCheckRollup?.state || 'N/A'}
+            </strong>
           </Typography>
         </Box>
       )}

plugins/github-pull-requests-board/src/components/EntityTeamPullRequestsCard/EntityTeamPullRequestsCard.test.tsx

@@ -71,7 +71,7 @@ jest.mock('../../hooks/usePullRequestsByTeam', () => {
         nodes: [],
       },
       commits: {
-        nodes: status,
+        nodes: [status],
       },
       isDraft: isDraft,
       author: {

plugins/github-pull-requests-board/src/components/EntityTeamPullRequestsContent/EntityTeamPullRequestsContent.test.tsx

@@ -71,7 +71,7 @@ jest.mock('../../hooks/usePullRequestsByTeam', () => {
         nodes: [],
       },
       commits: {
-        nodes: status,
+        nodes: [status],
       },
       isDraft: isDraft,
       author: {

plugins/github-pull-requests-board/src/components/PullRequestCard/PullRequestCard.tsx

@@ -30,7 +30,7 @@ type Props = {
   author: Author;
   url: string;
   reviews: Reviews;
-  status?: Status;
+  status?: Status[];
   repositoryName: string;
   repositoryIsArchived: boolean;
   isDraft: boolean;

plugins/github-pull-requests-board/src/utils/types.tsx

@@ -99,7 +99,7 @@ export type PullRequest = {
     nodes: Reviews;
   };
   commits: {
-    nodes: Status;
+    nodes: Status[];
   };
   mergeable: boolean;
   state: string;