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

docs(readme): lighthouse-ci #5410

Merged
merged 1 commit into from
Jun 15, 2018

Conversation

andreasonny83
Copy link
Contributor

Summary
Add lighthouse-ci to the list of Lighthouse's related projects.

@andreasonny83 andreasonny83 changed the title doc(README): lighthouse-ci doc(readme): lighthouse-ci Jun 3, 2018
@andreasonny83 andreasonny83 reopened this Jun 3, 2018
@andreasonny83 andreasonny83 changed the title doc(readme): lighthouse-ci docs(readme): lighthouse-ci Jun 3, 2018
Copy link
Member

@paulirish paulirish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

first of all.. really cool project! i like how straightforward you made it for users.

and very clean CLI interaction. gotta love ora.

that said i had some ideas... probably not what you were expecting when you filed this PR... :)

readme.md Outdated
@@ -282,6 +282,7 @@ Other awesome open source projects that use Lighthouse.
* **[lighthouse-lambda](https://github.com/joytocode/lighthouse-lambda)** - Run Lighthouse on AWS Lambda with prebuilt stable desktop Headless Chrome.
* **[lighthouse-security](https://github.com/voorhoede/lighthouse-security#readme)** - Run a set of security audits along with Lighthouse.
* **[Garie](https://github.com/boyney123/garie)** — An open source tool for monitoring performance using Lighthouse, PageSpeed Insights, [Prometheus](https://prometheus.io/), [Grafana](https://grafana.com/) and [Docker](https://www.docker.com/).
* **[lighthouse-ci](https://github.com/andreasonny83/lighthouse-ci)** - Integrate Google Lighthouse in your favourite Continuous Integration solution with zero configuration.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wdyt about this description:

Run Lighthouse and assert scores satisfy your custom thresholds.

readme.md Outdated
@@ -282,6 +282,7 @@ Other awesome open source projects that use Lighthouse.
* **[lighthouse-lambda](https://github.com/joytocode/lighthouse-lambda)** - Run Lighthouse on AWS Lambda with prebuilt stable desktop Headless Chrome.
* **[lighthouse-security](https://github.com/voorhoede/lighthouse-security#readme)** - Run a set of security audits along with Lighthouse.
* **[Garie](https://github.com/boyney123/garie)** — An open source tool for monitoring performance using Lighthouse, PageSpeed Insights, [Prometheus](https://prometheus.io/), [Grafana](https://grafana.com/) and [Docker](https://www.docker.com/).
* **[lighthouse-ci](https://github.com/andreasonny83/lighthouse-ci)** - Integrate Google Lighthouse in your favourite Continuous Integration solution with zero configuration.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i will admit we're working on making some CI stuff for lighthouse so we will likely ask you for this npm module name soon. :) (i've sent you some of our plans)

wdyt about renaming? something like lighthouse-score-assert seems cool.


and lastly an alternative implementation could be something like...

lighthouse http://mysite.com --output=json | lighthouse-score-assert --performance=90 --pwa=100

this way you don't have to support all of lighthouse CLI's flags in your own app, but can still support people who change throttling settings, pass in config-path's, etc

this seems mostly reasonable with your project except for the chromeFlags you add on. but that's not too bad for users. we plan to publish a docker container that will take care of all those sandboxing issues etc and make running lighthouse in CI a straightforward affair.

@andreasonny83
Copy link
Contributor Author

Thanks for your feedback @paulirish, I updated the README according to your suggestion.

Unfortunately, I don't think npm allows renaming or deleting already published npm packages. So my project's name is still lighthouse-ci for now.
If you know of any way of renaming npm packages, please let me know and I will be more than happy to change my package name.

I can see the value in passing the Lighthouse generated JSON report to my module just to process the information, however, I prefer to keep that logic inside my package responsibility for now and make sure the version is always in sync with the latest Lighthouse version.

Add lighthouse-ci to the list of Lighthouse's related projects.
@paulirish paulirish merged commit 426d96a into GoogleChrome:master Jun 15, 2018
@andreasonny83 andreasonny83 deleted the lighthouse-ci branch June 16, 2018 09:39
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

Successfully merging this pull request may close these issues.

2 participants