GithubActions Logging Implementation #2172

NetPenguins · 2020-08-29T14:27:36Z

Hey, I just made a Pull Request!

Pull request for #1858

Added WorkflowRunLogs
Updated WorkflowRunDetails to display WorkflowRunLogs element per job.
Extended GithubActions* with downloadJobLogsForWorkflowRun

WorkflowRunDetails will pass in a Job object to WorkflowRunLogs element. We then use WorkflowRunLogs to find the associated log for the passed in job. Once we have the run we will create a new Accordion element to house a LazyLog component and a Modal component. The user can either choose to expand the Accordion to view the logs within the context of the parent object, or click the Open Logs icon to the right to open the Modal. In both cases the AccordionSummary and Modal will house a DisplayLog object.

In the event the run is still in progress or queued we will disable the associated Accordion object.

CircularProgress was added to the Accordion element.

Syntax highlighting is used to identify if the line in LazyLog message contains error, failed or failure and changes the font color to red for easier identification of errors. Errors will also cause the boxShadow to turn red and displays a red icon.

✔️ Checklist

All tests are passing yarn test
Screenshots attached (for UI changes)
Relevant documentation updated
Prettier run on changed files
Tests added for new functionality
Regression tests added for bug fixes

NetPenguins · 2020-08-30T12:27:48Z

Mistake in using outdated repo. . . revising now.

shmidt-i · 2020-08-31T08:24:07Z

Regarding repo - you can use spotify/backstage itself, has a lot of workflows and (only sometimes 😉 ) failures

shmidt-i

Nice job! Some comments below:

shmidt-i · 2020-08-31T08:25:29Z

plugins/github-actions/src/api/GithubActionsClient.ts

+    owner: string;
+    repo: string;
+    runId: number;
+  }): Promise<any> {


Could you avoid any here?

Good call out. I plugged in Promise<EndpointInterface> and have good results. Will place in the update.

shmidt-i · 2020-08-31T08:26:16Z

plugins/github-actions/src/components/WorkflowRunLogs/WorkflowRunLogs.tsx

+    ExpansionPanelSummary,
+} from '@material-ui/core';
+
+import React, {Suspense} from 'react';


Looks like prettier wasn't ran here

shmidt-i · 2020-08-31T08:28:33Z

plugins/github-actions/src/components/WorkflowRunLogs/WorkflowRunLogs.tsx

+  if (!entityCompoundName.name) {
+    // TODO(shmidt-i): remove when is fully integrated
+    // into the entity view
+    entityCompoundName = {
+      kind: 'Component',
+      name: 'backstage',
+      namespace: 'default',
+    };
+  }


Soon will be gone, but nothing to do now ;)

Aaand since #2076 was merged, this is subject to be redone similar to
https://github.com/spotify/backstage/blob/8888b0c801002dd4112615955c2a2799f32015a9/plugins/github-actions/src/components/WorkflowRunsTable/WorkflowRunsTable.tsx#L157

Ping me on discord if you have any questions, will be happy to help you out!

Like the new look!👌 I will look over the changes from what I see it's basically just removing the entityCompoundName in favor of the imported Entity but I'll reach out if I run into any questions

shmidt-i · 2020-08-31T08:29:47Z

plugins/github-actions/src/components/WorkflowRunLogs/WorkflowRunLogs.tsx

+        }}
+        >
+            <Typography variant="button">
+            {jobLogs.value === null ? "No Logs to Display" : "Job Log"}


Some loading state here would be great

For this one I just tested while a build was in progress and see the issue with this currently. I will update to check for in progress or not and display accordingly.

…ations.

freben · 2020-09-03T14:02:09Z

Just a small conflict left! (oh I also saw the comment about simplified hook for getting the project name) Let us know if we can help out.

stefanalund · 2020-09-04T06:50:22Z

Fixes #2238

NetPenguins · 2020-09-07T15:24:23Z

@shmidt-i @freben Resolved the yarn.lock conflicts and have incorporated the new entity usage. I am running into an issue where yarn install fails during the checks due to Cypress. Have you come across this issue before?

shmidt-i · 2020-09-07T21:40:34Z

It seems like it happens from time to time, was able to find this issue cypress-io/cypress#6789

freben · 2020-09-07T21:48:04Z

Good find - that's a crappy bug cypress bug...

Will you retrigger the workflows?

shmidt-i · 2020-09-07T21:48:14Z

yarn.lock

+cypress@*:
+  version "5.0.0"
+  resolved "https://registry.npmjs.org/cypress/-/cypress-5.0.0.tgz#6957e299b790af8b1cd7bea68261b8935646f72e"
+  integrity sha512-jhPd0PMO1dPSBNpx6pHVLkmnnaTfMy3wCoacHAKJ9LJG06y16zqUNSFri64N4BjuGe8y6mNMt8TdgKnmy9muCg==


It may have something to do with this addition

Yeah likely, can you make it resolve to the same version as the other one?

The yarn.lock changes should be removed from this PR, except for the lazylog addition

shmidt-i · 2020-09-07T21:49:52Z

Good find - that's a crappy bug cypress bug...

Will you retrigger the workflows?

I tried, still failing. Let's see tomorrow, maybe time heals. Or will investigate more why this 5.0 version appeared 🤷‍♂️

freben · 2020-09-07T21:52:59Z

Mm, the ticket you linked describes it (or one that it in turn links to perhaps?). I wonder if the dedupe command actually removes it too and makes it point to 4.x like the other one

NetPenguins · 2020-09-12T15:57:37Z

All updates made and conflicts resolved.

shmidt-i · 2020-09-12T17:16:14Z

Very good, thanks! 🎉

NetPenguins added 2 commits August 29, 2020 09:59

Added LazyLog to Github-Actions for displaying workflow run logs.

21bd252

Eliminated console.log line that was carried over.

ea010b7

NetPenguins requested a review from a team as a code owner August 29, 2020 14:27

NetPenguins marked this pull request as draft August 30, 2020 12:26

NetPenguins added 3 commits August 30, 2020 09:45

Merge remote-tracking branch 'upstream/master'

8cce7f2

Update to include JobLog component.

a31afed

yarn.lock added back

f3a1049

shmidt-i reviewed Aug 31, 2020

View reviewed changes

Return correct type, added modal for log visuals, added loading indic…

9869947

…ations.

NetPenguins marked this pull request as ready for review September 1, 2020 18:34

NetPenguins added 2 commits September 1, 2020 14:40

left out a dev tweak . . .

03f0a23

Updated ExpansionPanel to Accordion

46642db

NetPenguins mentioned this pull request Sep 4, 2020

Change ExpansionPanel to Accordion #2238

Closed

NetPenguins added 6 commits September 5, 2020 08:21

Merge branch 'master' of https://github.com/spotify/backstage

0b870cc

ran yarn install

ab2e0f2

Update to include Entity object

66a0239

Removal of entityCompound import

cad82da

Merge remote-tracking branch 'upstream/master'

f21aef7

Entity needed to be passed to logs component.

2133418

shmidt-i approved these changes Sep 7, 2020

View reviewed changes

shmidt-i reviewed Sep 7, 2020

View reviewed changes

NetPenguins added 3 commits September 12, 2020 09:10

Merge remote-tracking branch 'upstream/master'

7cd4ae1

pull file from upstream to revert changes

9b428ee

prettier misconfigured

b4d4af5

shmidt-i merged commit 4780043 into backstage:master Sep 12, 2020

themousepotato mentioned this pull request Oct 25, 2020

Github Actions: logs visualization #1858

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GithubActions Logging Implementation #2172

GithubActions Logging Implementation #2172

NetPenguins commented Aug 29, 2020 •

edited

NetPenguins commented Aug 30, 2020

shmidt-i commented Aug 31, 2020

shmidt-i left a comment

shmidt-i Aug 31, 2020

NetPenguins Aug 31, 2020 •

edited

shmidt-i Aug 31, 2020

shmidt-i Aug 31, 2020

shmidt-i Sep 3, 2020

NetPenguins Sep 4, 2020 •

edited

shmidt-i Aug 31, 2020

NetPenguins Aug 31, 2020

freben commented Sep 3, 2020

stefanalund commented Sep 4, 2020

NetPenguins commented Sep 7, 2020

shmidt-i commented Sep 7, 2020

freben commented Sep 7, 2020

shmidt-i Sep 7, 2020

freben Sep 7, 2020

Rugvip Sep 7, 2020

shmidt-i commented Sep 7, 2020

freben commented Sep 7, 2020

NetPenguins commented Sep 12, 2020

shmidt-i commented Sep 12, 2020

GithubActions Logging Implementation #2172

GithubActions Logging Implementation #2172

Conversation

NetPenguins commented Aug 29, 2020 • edited

Hey, I just made a Pull Request!

✔️ Checklist

NetPenguins commented Aug 30, 2020

shmidt-i commented Aug 31, 2020

shmidt-i left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NetPenguins Aug 31, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NetPenguins Sep 4, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freben commented Sep 3, 2020

stefanalund commented Sep 4, 2020

NetPenguins commented Sep 7, 2020

shmidt-i commented Sep 7, 2020

freben commented Sep 7, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shmidt-i commented Sep 7, 2020

freben commented Sep 7, 2020

NetPenguins commented Sep 12, 2020

shmidt-i commented Sep 12, 2020

NetPenguins commented Aug 29, 2020 •

edited

NetPenguins Aug 31, 2020 •

edited

NetPenguins Sep 4, 2020 •

edited