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

Create a Tachometer GitHub Action #142

Open
aomarks opened this issue Dec 20, 2019 · 4 comments
Open

Create a Tachometer GitHub Action #142

aomarks opened this issue Dec 20, 2019 · 4 comments

Comments

@aomarks
Copy link
Member

aomarks commented Dec 20, 2019

We have a somewhat complicated integration that works with Travis or any other CI system. I think that now that GitHub Actions exist, we could have a much simpler workflow instead.

@aomarks aomarks self-assigned this Dec 20, 2019
@cdata
Copy link
Contributor

cdata commented Jul 28, 2020

Can you share any additional details about what makes integration complicated today?

@aomarks
Copy link
Member Author

aomarks commented Jul 28, 2020

The way we currently do perf regression testing for the lit-element and lit-html repos is by running tachometer piggy-backed on Travis, alongside the unit tests. Tachometer itself then knows how to post its results back using the GitHub API, using credentials for a GitHub "App" so that it shows up as its own result "check" (e.g. https://github.com/Polymer/lit-element/pull/987/checks).

Relevant code:

https://github.com/Polymer/lit-element/blob/master/travis-bench.sh
https://github.com/Polymer/lit-element/blob/master/.travis.yml
https://github.com/Polymer/tachometer/blob/master/src/github.ts

So, switching to a GitHub Action would be much simpler, since we shouldn't need any of this API integration, credential passing, or Travis-piggybacking. Open question how we display the result table, though. For a GitHub Check, the API lets you post markdown that will show up in the Checks tab. Maybe an Action can also be a check? Maybe it can post a comment? I'm slightly fuzzy on the interaction between Actions and Checks here.

@cdata cdata self-assigned this Aug 7, 2020
@andrewiggins
Copy link
Contributor

andrewiggins commented Aug 12, 2020

@cdata (mentioning you since you assigned yourself to this) FWIW I built a GitHub action to report tachometer results as a comment in a PR: andrewiggins/tachometer-reporter-action.

I found that trying to use the checks API and actions together is not as valuable since an action job shows up as a check on a PR so the additional check felt redundant.

Anyway, happy to discuss ways to make this more helpful to the community if you are interested

@andrewiggins
Copy link
Contributor

FYI - just added support for multiple measurements per benchmarks in my reporter action, one thing that was notably missing before.

@aomarks aomarks moved this to Needs Discussion in Lit Project Board Jan 24, 2022
@aomarks aomarks moved this from Needs Discussion to Todo in Lit Project Board Jan 24, 2022
@aomarks aomarks moved this from 🔥 Front Burner to 🧊 Icebox in Lit Project Board Mar 15, 2022
@aomarks aomarks moved this from 🧊 Icebox to 📋 Triaged in Lit Project Board Jun 21, 2022
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

3 participants