Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow users to easily share job output on GitHub #69

Open
Manfred opened this issue Nov 8, 2019 · 2 comments
Open

Allow users to easily share job output on GitHub #69

Manfred opened this issue Nov 8, 2019 · 2 comments

Comments

@Manfred
Copy link
Collaborator

Manfred commented Nov 8, 2019

  • As a user I want to share job output on GitHub so I can show performance measurements related to my work.

We want to make it easy to share job output on issues and pull requests on GitHub.

In the past this was implemented by letting the PerfCheck GitHub user post to pull requests or issues. We found that this caused a lot of noise on the tickets as people were repeatedly posting information.

It would probably be better if they could add a single piece of formatting to their PR description or comment with an SVG image link or something similar which would present the output with a link back to the full output.

![http://perf-check/jobs/42.svg](http://perf-check/jobs/42)

Optionally we can also have a button somewhere that instructs the PerfCheck bot to look for a PR for the benchmarked branch and add a comment with this markup.

@sudara
Copy link
Member

sudara commented Nov 9, 2019

present the output with a link back to the full output.

I'm currently mulling over whether we should actually try and go a very minimal "badge" route (can play on https://shields.io to imagine)

Given that there can be multiple urls tested, we'd probably want a badge per url. And URLs are long, so maybe this is a bad idea.

Optionally we can also have a button somewhere that instructs the PerfCheck bot to look for a PR for the benchmarked branch and add a comment with this markup.

+1 for this. I'm thinking we should preview the badge on the job, give them a button to "copy url to badge" and "post badge to PR".

@sudara
Copy link
Member

sudara commented Nov 9, 2019

image

A problem with pill-like badges is I'm loathe to lose fidelity on "absolute" problems just because relative performance doesn't change.

However, we could have a very simple representation, with ability to show 1 "absolute" result on the right side.

Prob better to actually design a multi-url "banner" vs. a badge though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants