First go at a sitespeed.io Github Action. (#2269)

docker/Dockerfile-plus1

@@ -1,4 +1,5 @@
-FROM sitespeedio/sitespeed.io:latest
+ARG version
+FROM sitespeedio/sitespeed.io:{version}
 
 ENV SITESPEED_IO_BROWSERTIME__XVFB true
 ENV SITESPEED_IO_BROWSERTIME__DOCKER true

docker/github-action/Dockerfile

@@ -0,0 +1,11 @@
+ARG version
+FROM sitespeedio/sitespeed.io:${version}
+
+LABEL "com.github.actions.name"="Run sitespeed.io"
+LABEL "com.github.actions.description"="Test the performance of your web site"
+LABEL "com.github.actions.icon"="monitor"
+LABEL "com.github.actions.color"="blue"
+
+LABEL "repository"="https://github.com/sitespeedio/sitespeed.io"
+LABEL "homepage"="https://www.sitespeed.io/documentation/sitespeed.io/continuous-integration/#github-actions"
+LABEL "maintainer"="Peter Hedenskog <peter@soulgalore.com>"

docker/github-action/README.md

@@ -0,0 +1,50 @@
+# sitespeed.io Github action
+
+If you are using [Github Actions](https://github.com/features/actions) beta it's super easy to run sitespeed.io. Remember though that actions are in beta and can change. They are running an small instances at the moment so you shouldn't rely on timing metrics. 
+
+Actions works good with a [performance budget](https://www.sitespeed.io/documentation/sitespeed.io/performance-budget/). You should set your budget in a file in the repo that you are testing. In this example we call the file *budget.json* and put it in the *.github* folder in the repo.
+
+Setup a simple budget that check the URLs you test against number of requests, transfer sise, third parties and different Coach scores ([read the documentation](https://www.sitespeed.io/documentation/sitespeed.io/performance-budget/#full-example) on how to configure other metrics):
+
+```json
+{
+  "budget": {
+    "requests": {
+        "total": 100
+    },
+    "transferSize": {
+        "total": 400000
+    },
+    "thirdParty": {
+        "requests": 0
+    },
+    "score": {
+      "accessibility": 100,
+      "bestpractice": 100,
+      "privacy": 100,
+      "performance": 100
+    }
+  }
+}
+```
+
+Then you can setup your action either via the Github GUI or using configuration. Make sure to setup your action to the right Docker file: ```docker://sitespeedio/sitespeed.io:{% include version/sitespeed.io.txt %}-action```.
+
+A simple setup looks something like this:
+
+```shell
+workflow "Testing stage environment" {
+  on = "push"
+  resolves = ["Run sitespeed.io"]
+}
+
+action "Run sitespeed.io" {
+  uses = "docker://sitespeedio/sitespeed.io:{% include version/sitespeed.io.txt %}-action"
+  args = "https://www.sitespeed.io -n 1 --budget.configPath /github/workspace/.github/budget.json"
+}
+```
+As argument you can use all [configurations options](https://www.sitespeed.io/documentation/sitespeed.io/configuration/#the-options) as you usually do with sitespeed.io. Since we don't use any timing metrics in the budget we only do one run.
+
+If your budget fails, your action will fail.
+
+When there's a new sitespeed.io release and you wanna use that you just bump the version number of your action.

docs/documentation/sitespeed.io/continuous-integration/index.md

@@ -22,6 +22,56 @@ You can use sitespeed.io to keep track of what is happening with your site by ma
 
 To do this you define your own [budget file](../performance-budget/#the-budget-file) with rules on when to break your build. This budget will return an error code status after the run. You can also choose to output JUnit XML and TAP reports.
 
+## Github Actions
+If you are using [Github Actions](https://github.com/features/actions) beta it's super easy to run sitespeed.io. Remember though that actions are in beta and can change. They are running an small instances at the moment and you have no way of [setting the connectivity](/documentation/sitespeed.io/connectivity/) so you shouldn't rely on timing metrics. 
+
+Actions works good with a [performance budget](documentation/sitespeed.io/performance-budget/). You should set your budget in a file in the repo that you are testing. In this example we call the file *budget.json* and put it in the *.github* folder in the repo.
+
+Setup a simple budget that check the URLs you test against number of requests, transfer sise, third parties and different Coach scores ([read the documentation](/documentation/sitespeed.io/performance-budget/#full-example) on how to configure other metrics):
+
+```json
+{
+  "budget": {
+    "requests": {
+        "total": 100
+    },
+    "transferSize": {
+        "total": 400000
+    },
+    "thirdParty": {
+        "requests": 0
+    },
+    "score": {
+      "accessibility": 100,
+      "bestpractice": 100,
+      "privacy": 100,
+      "performance": 100
+    }
+  }
+}
+```
+
+Then you can setup your action either via the Github GUI or using configuration. Make sure to setup your action to the right Docker file: ```docker://sitespeedio/sitespeed.io:{% include version/sitespeed.io.txt %}-action```.
+
+A simple setup looks something like this:
+
+```shell
+workflow "Testing stage environment" {
+  on = "push"
+  resolves = ["Run sitespeed.io"]
+}
+
+action "Run sitespeed.io" {
+  uses = "docker://sitespeedio/sitespeed.io:{% include version/sitespeed.io.txt %}-action"
+  args = "https://www.sitespeed.io -n 1 --budget.configPath /github/workspace/.github/budget.json"
+}
+```
+As argument you can use all [configurations options](/documentation/sitespeed.io/configuration/#the-options) as you usually do with sitespeed.io. Since we don't use any timing metrics in the budget we only do one run.
+
+If your budget fails, your action will fail.
+
+When there's a new sitespeed.io release and you wanna use that you just bump the version number of your action.
+
 ## Jenkins
 The most convenient way to run in Jenkins is to use the pre-built Docker containers. You can run an installed npm version too, but that method will require additional work as you will need to setup browsers and use the [Xvfb plugin](https://wiki.jenkins-ci.org/display/JENKINS/Xvfb+Plugin) to make the browsers run in headless mode. Trust us use the Docker Images you will thank us later. ;-)
 
@@ -79,13 +129,13 @@ jobs:
       - run: sudo modprobe ifb numifbs=1
 
       # 3G
-      - run: docker run --cap-add=NET_ADMIN --shm-size=1g --rm sitespeedio/sitespeed.io:7.7.2 -c 3g --browsertime.connectivity.engine=throttle https://www.sitespeed.io/
+      - run: docker run --cap-add=NET_ADMIN --shm-size=1g --rm sitespeedio/sitespeed.io:{% include version/sitespeed.io.txt %} -c 3g --browsertime.connectivity.engine=throttle https://www.sitespeed.io/
 
       # No Traffic shaping
-      - run: docker run --shm-size=1g --rm sitespeedio/sitespeed.io:7.7.2 https://www.sitespeed.io/
+      - run: docker run --shm-size=1g --rm sitespeedio/sitespeed.io:{% include version/sitespeed.io.txt %} https://www.sitespeed.io/
 
       # No traffic shaping with performance budget
-      - run: docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io:7.7.2 -n 3 --budget.configPath myBudget.json https://www.sitespeed.io/
+      - run: docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io:{% include version/sitespeed.io.txt %} -n 3 --budget.configPath myBudget.json https://www.sitespeed.io/
 
 workflows:
   version: 2

docs/documentation/sitespeed.io/index.md

@@ -27,7 +27,7 @@ Sitespeed.io is the complete toolbox to test the web performance of your web sit
 
 ## More details
  * [Alerts](alerts/) - send alerts (email/Slack/PagerDuty etc) when you get a performance regression.
- * [Continuous Integration](continuous-integration/) - generate JUnit XML/TAP and use Jenkins, Circle CI, Gitlab CI,  Grunt or the Gulp plugin.
+ * [Continuous Integration](continuous-integration/) - generate JUnit XML/TAP and use Jenkins, Circle CI, Gitlab CI, Github Actions, Grunt or the Gulp plugin.
  * [Developers](developers/) - start here when you want to do PRs or create a plugin.
  * [Graphite](graphite/) - how to configure and store your metrics in Graphite (and using StatsD).
  * [How to Write a Good Bug Report](bug-report/) - if you write a good bug report, we can spend more time helping you fixing the problem instead of asking you questions

release.sh

@@ -19,7 +19,10 @@ docker build --no-cache -t sitespeedio/sitespeed.io:$PACKAGE_VERSION -t sitespee
 docker push sitespeedio/sitespeed.io:$PACKAGE_VERSION
 docker push sitespeedio/sitespeed.io:latest
 
-docker build -t sitespeedio/sitespeed.io:$PACKAGE_VERSION-plus1 --file docker/Dockerfile-plus1 .
+docker build -t sitespeedio/sitespeed.io:$PACKAGE_VERSION-action --build-arg version=$PACKAGE_VERSION --file docker/github-action/Dockerfile .
+docker push sitespeedio/sitespeed.io:$PACKAGE_VERSION-action
+
+docker build -t sitespeedio/sitespeed.io:$PACKAGE_VERSION-plus1 --build-arg version=$PACKAGE_VERSION --file docker/Dockerfile-plus1 .
 docker push sitespeedio/sitespeed.io:$PACKAGE_VERSION-plus1
 
 # Update to latet version in the docs