(feat) initial commit

README.md

@@ -1 +1,85 @@
-# drone-diagnostics
+A plugin to cli tools to diagnose issues in a build.
+
+# Usage
+
+This plugin has a number of diagnosic tools installed, use the command syntax to access them.
+
+Installed tools:
+ping, tracroute
+
+## Example 1
+
+The below example skips the implicit clone step. Then displays the environment variables, then checks access to github. With ping and traceroute.
+
+```yaml
+kind: pipeline
+name: default
+
+clone:
+  disable: true
+
+steps:
+- name: run tphoney/drone-diagnostics plugin
+  image: tphoney/drone-diagnostics
+  pull: if-not-exists
+  commands:
+    - env
+    - ping www.github.com -w 5
+    - traceroute -T -p 443 www.github.com
+    - echo "end of test"
+```
+
+## Example 2 
+
+If the ftp upload fails, check connectivity to the ftp server. Useful for flakey networks.
+
+```yaml
+kind: pipeline
+name: default
+
+
+steps:
+- name: upload to ftp server
+  image: alpine
+  commands:
+    - echo 'ftp rules' # perform some ftp commands
+- name: run tphoney/drone-diagnostics plugin
+  image: tphoney/drone-diagnostics
+  pull: if-not-exists
+  commands:
+    - ping ftp.server
+    - echo "end of test"
+  when:
+    status:
+    - failure
+```
+
+Build the plugin image:
+
+```text
+docker build -t tphoney/drone-diagnostics -f docker/Dockerfile .
+```
+
+# Testing
+
+
+Build the plugin image:
+
+```text
+docker build -t tphoney/drone-diagnostics -f docker/Dockerfile .
+```
+
+# Testing
+
+Execute the plugin from your current working directory:
+
+```text
+docker run --rm -e PLUGIN_PARAM1=foo -e PLUGIN_PARAM2=bar \
+  -e DRONE_COMMIT_SHA=8f51ad7884c5eb69c11d260a31da7a745e6b78e2 \
+  -e DRONE_COMMIT_BRANCH=master \
+  -e DRONE_BUILD_NUMBER=43 \
+  -e DRONE_BUILD_STATUS=success \
+  -w /drone/src \
+  -v $(pwd):/drone/src \
+  tphoney/drone-diagnostics
+```