From f163bb8b276986b5cc4f02f1c2ea08ddc7b0a952 Mon Sep 17 00:00:00 2001 From: Lukas Gravley Date: Thu, 9 Jan 2020 14:21:43 -0600 Subject: [PATCH] adding doc --- .automation/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .automation/README.md diff --git a/.automation/README.md b/.automation/README.md new file mode 100644 index 00000000..12b93fd9 --- /dev/null +++ b/.automation/README.md @@ -0,0 +1,19 @@ +# .automation +This folder holds automation scripts to help `deploy` and `cleanup` **DockerHub** images of the **Super-Linter** + +## cleanup-docker.md +This script uses **GitHub Actions** so that when a PR is merged and closed, the **GitHub Action** is triggered. +It will then search **DockerHub** for the image that was deployed during the development, and remove it. + +## upload-docker.sh +This script uses **GitHub Actions** so that a push to the repository is committed, it will complete the following: +- Checkout the source code +- Build the **Docker** container for **Super-Linter** using that source code +- Upload the container to **DockerHub** + +When the script is triggered on master, it will push with the tag:**latest** which is used by all scripting for general avilablity. +When the script is triggered in a branch, it will push with the tag:**NameOfBranch** which can be used for: +- *testing* +- *troubleshooting* +- *debugging* +- **Note:** The branch name will be reduced to AlpaNumeric for consistancy and uploading