gitactionboard icon indicating copy to clipboard operation
gitactionboard copied to clipboard

Add flag to render only job name

Open kvashchuka opened this issue 1 year ago • 15 comments

When displaying action statuses of just one repo, it is unnecessary to display the repo name. The "Show job name only" switch will give a user an option to hide repo name and workflow name, leaving only the job name, thus increasing readability.

kvashchuka avatar Jul 31 '23 12:07 kvashchuka

Thanks for opening this pull request! Please check out our contributing guidelines!

boring-cyborg[bot] avatar Jul 31 '23 12:07 boring-cyborg[bot]

Hi @sumanmaity1234 Thanks a lot for your review! We have now addressed all the comments, and made requested changes.

kvashchuka avatar Aug 02 '23 08:08 kvashchuka

Hi @kvashchuka, I was thinking about this feature. The current solution really works well for single repository but once user has multiple repository, this solution might not add much value. Therefor I was thinking will it be possible for you to extend the solution to work with multiple repository as well?

One idea could be, allow user to configure which part they are interested, some might want to hide the workflow name, some might repository or combinations of it.

sumanmaity1234 avatar Aug 03 '23 16:08 sumanmaity1234

hi @sumanmaity1234,

as @kvashchuka is gone for a few weeks, they've asked if I could pick up the mantle on this.

I'll look into implementing your suggestion. however, would it be possible for me to use this feature to look into a new layout for the cards?

aronhoyer avatar Aug 04 '23 09:08 aronhoyer

Hi @aronhoyer, sure, feel free to update the design. But before you put lot to effort to change it every where maybe you can post the design here

sumanmaity1234 avatar Aug 04 '23 10:08 sumanmaity1234

did a few quick explorations. I feel like this direction would eliminate this entire pr, but overall a better direction

Screenshot 2023-08-04 at 14 23 42

aronhoyer avatar Aug 04 '23 12:08 aronhoyer

Hi @aronhoyer, overall design looks interesting but couple of things I think you overlook

  • The name is consists of [Repository name] :: [Workflow Name] :: [Job Name], we don't have branch name
  • For some users, Name can be really long, therefor I am not sure if this design will work for all the users
  • For workflow dashboard, we have possibility to hide or show the card/job
  • Incase of build failure, we display for how long it's failing

Addition to all the above mentioned points, we need to make sure that good numbers of cards/jobs are displayed on the screen without scrolling, so we need to choose height and width accordingly.

If the above points can be easily incorporated in the design then it'll really nice from the product point of view

sumanmaity1234 avatar Aug 04 '23 13:08 sumanmaity1234

just a general note: all four rows explore different alternatives to the card design and how to display the job status. the designs would not appear at the same time. not sure whether that was unclear or not.

  • The name is consists of [Repository name] :: [Workflow Name] :: [Job Name], we don't have branch name

yeah I meant to write repo name instead of branch name 😅 that's my b

  • For some users, Name can be really long, therefor I am not sure if this design will work for all the users

that's why I thought splitting up the parts that make up the formatted name would be beneficial. we could also do things like truncating the job name if it exceeds two lines or something.

  • For workflow dashboard, we have possibility to hide or show the card/job

not a problem at all. maybe, to not clutter the ui too much if there are many jobs displayed on the dashboard, the show/hide button could appear once the user hovers the card?

  • Incase of build failure, we display for how long it's failing

not a problem either

aronhoyer avatar Aug 04 '23 13:08 aronhoyer

that's why I thought splitting up the parts that make up the formatted name would be beneficial. we could also do things like truncating the job name if it exceeds two lines or something.

I think it'll good to keep the job name as it is (at least for the first try) and maybe we can truncate the repo name and workflow name.

not a problem at all. maybe, to not clutter the ui too much if there are many jobs displayed on the dashboard, the show/hide button could appear once the user hovers the card?

Not sure how it'll work as somehow we have make it prominent that on click on the card it'll open on GitHub.

sumanmaity1234 avatar Aug 04 '23 15:08 sumanmaity1234

created a Figma prototype https://www.figma.com/proto/kain0iyc8Cf0zkbV5QoOD6/Untitled?page-id=0%3A1&type=design&node-id=20-83&viewport=238%2C401%2C0.71&t=qNZ3OIAsKstmRDla-1&scaling=min-zoom&mode=design

Not sure how it'll work as somehow we have make it prominent that on click on the card it'll open on GitHub.

good shout. I guess the card should have some hover effect

aronhoyer avatar Aug 04 '23 21:08 aronhoyer

Hi @aronhoyer, The design looks good to me. But I have the following questions -

  • Are you using yellow color to represent in progress job?
Screenshot 2023-08-05 at 9 54 00 AM
  • How are you planning to indicate the last run status?

sumanmaity1234 avatar Aug 05 '23 08:08 sumanmaity1234

@sumanmaity1234 hi! sorry I went awol for a bit. fell ill and this kinda fell to the wayside

Are you using yellow color to represent in progress job?

that was the idea. either that or a looping progress bar type animation.

How are you planning to indicate the last run status?

won't that just be the first card in the list?

aronhoyer avatar Sep 11 '23 12:09 aronhoyer

Hi @aronhoyer, I hope you are better now.

that was the idea. either that or a looping progress bar type animation.

Sure, that make sense. I just wanted to clarify my doubt.

won't that just be the first card in the list?

Unable to understand what do you meant by "first card". In the dashboard, you'll have single grid/box for each job.

My question was related to the last run status for a job. For example, in the following image, you can see the current jobs are running but it also indicate the last run status, for job 1 (webpack-dev-server :: Cancel :: Cancel Previous Runs), it's passed and for job2 (webpack-dev-server :: webpack-dev-server :: Test - windows-latest - Node v16.x, Webpack latest) it's failed

Screenshot 2023-09-11 at 6 08 22 PM

Note: screenshot is from https://otto-de.github.io/gitactionboard/#/workflow-jobs

sumanmaity1234 avatar Sep 11 '23 16:09 sumanmaity1234

Hi @sumanmaity1234! I think this PR lost traction as the scope grew larger. Could we please go back a step and reconsider merging the PR with the original intent (aka simply have a flag to only show the job name)? I do understand that it is not a perfect solution for every user, but it makes a big difference for the usage of gitaction board for my team and I believe it does not have any negative impact on other users.

kvashchuka avatar Oct 31 '23 14:10 kvashchuka

Hi @kvashchuka, could you please check if your changes works with the latest codebase? Also please add a screenshot how will it look post your changes.

Additionally, there are couple of code change requested.

Once these changes are done, I'll merge the PR

Thanks

sumanmaity1234 avatar Feb 04 '24 10:02 sumanmaity1234