Performance Preview - WaterFall Chart
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- github-actions, typescript, vscode
- Domain
- ci-cd, data-visualization, devtools
Research direction
No files, tests, or entry points are identified. First clarify whether this belongs in the VS Code extension or the web UI, and define the scope for workflow-run data versus local workflow previews. Done would require an agreed design, data format, visualization behavior, and implementation plan.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem? Please describe.
I think CI/CD systems can get extremely complex. I don't think it's that crazy to believe that some workflows will run 3-5 machines in parallel and branch up to around 20 jobs. I work at a company that has very rigorous compliance standards and I have a goal to move all of our compliance steps away from the primary thread our users will do work on. Ultimately trying to speed up pipelines and better devex. I think it would be amazing if we could visualize this better.
Describe the solution you'd like
This requirement sent me down a rabbit hole thinking: What if when I changed a workflow file locally and it showed me a preview of how more performant my workflow run would be? Something like Chrome Dev Tools network tab?
Then I could even move a task (Single Github action step) to another spot in the workflow file and that chart would change automatically. Maybe change the title to clearly show this is now a preview if your change worked.
I think if we really nailed this implementation I think it could save complex workflow writers a lot of time.
So I would add a new command to show this chart in a preview (New tab to the right in VSCode).
Additional context
First and foremost I know this is kind of a crazy ask. So I am totally ok with you saying: Nah this is crazy go do this in a separate extension. I just feel since you are already authenticated and making the API request it's the right place for it.
Secondly this might be something better suited for the actual web ui. Even if it didn't auto update based on local changes to a workflow file, this view of a workflow might still be useful.
I know this is a bit half baked but I am really trying to gauge if other users would find this interesting.
If this issue was accepted as a feature request to the product and I was working on it I would split this into 2 parts
- Find a way to take existing workflow runs and create a performance preview in JSON or some other data format based off a potential workflow file change.
- Find a way to visualize existing workflow executions as a waterfall chart or something that can consume this data.
PS: If people liked this idea I would definitely be interested in contributing the change
- Dominant language
- TypeScript
- Stars
- 661
- Forks
- 214
- PR merge metrics
- No merged PRs in 30d
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/vscode-github-actions
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
github/vscode-github-actions#627 · 2 reactions ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
github/vscode-github-actions#630 · 2 comments · 2 reactions ·
-
long workOpen
Difficulty 4/5 3-5 days Newbie friendliness 25/100
github/vscode-github-actions#628 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 55/100
github/vscode-github-actions#625 ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 64/100
github/vscode-github-actions#621 · 3 comments ·
All issues in github/vscode-github-actions
Similar issues
-
docs
Difficulty 1/5 Under an hour Newbie friendliness 68/100
remix-run/react-router#15558 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
solana-foundation/pay-kit#341 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
supabase/agent-skills#607 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day