gh action doc (#29)

* gh action doc Signed-off-by: Michael Kalantar <[email protected]> * update text Signed-off-by: Michael Kalantar <[email protected]> * change title Signed-off-by: Michael Kalantar <[email protected]>
iter8-tools · May 3, 2022 · ffb7a05 · ffb7a05
1 parent 4dd8e44
commit ffb7a05
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/tutorials/integrations/ghactions.md b/docs/tutorials/integrations/ghactions.md
@@ -0,0 +1,15 @@
+---
+template: main.html
+---
+
+# Use Iter8 in a GitHub Actions workflow
+
+Install the latest version of Iter8 using the GitHub Action `iter8/[email protected]`. Once installed, Iter8 can be used as documented (see [user guide](../../user-guide/commands/iter8.md)) in `run` actions. For example:
+
+```yaml
+- uses: iter8/[email protected] # install Iter8
+- run: |
+    iter8 version
+    iter8 launch -c load-test-http \
+    --set url=http://httpbin.org/get
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -137,6 +137,7 @@ nav:
     - Kubernetes usage: tutorials/load-test-grpc/kubernetesusage.md
   - Integrations:
     - Overview: tutorials/integrations/overview.md
+    - GitHub Actions: tutorials/integrations/ghactions.md
     - Knative:
       - Benchmark and validate HTTP: tutorials/integrations/knative/load-test-http.md
       - Benchmark and validate gRPC: tutorials/integrations/knative/load-test-grpc.md