2020-01-09 15:21:43 -05:00
|
|
|
# .automation
|
2020-07-21 13:08:05 -04:00
|
|
|
|
2020-01-09 15:21:43 -05:00
|
|
|
This folder holds automation scripts to help `deploy` and `cleanup` **DockerHub** images of the **Super-Linter**
|
|
|
|
|
|
2020-06-20 00:00:01 -04:00
|
|
|
## cleanup-docker.sh
|
2020-07-21 13:08:05 -04:00
|
|
|
|
2020-01-09 15:21:43 -05:00
|
|
|
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
|
2020-07-21 13:08:05 -04:00
|
|
|
|
2020-06-20 00:00:01 -04:00
|
|
|
This script uses **GitHub Actions** so that when a push to the repository is committed, it will complete the following:
|
2020-07-21 13:08:05 -04:00
|
|
|
|
2020-01-09 15:21:43 -05:00
|
|
|
- Checkout the source code
|
|
|
|
|
- Build the **Docker** container for **Super-Linter** using that source code
|
|
|
|
|
- Upload the container to **DockerHub**
|
|
|
|
|
|
2020-02-05 10:30:39 -05:00
|
|
|
When the script is triggered on master, it will push with the tag:**latest** which is used by all scripting for general availability.
|
2020-01-09 15:21:43 -05:00
|
|
|
When the script is triggered in a branch, it will push with the tag:**NameOfBranch** which can be used for:
|
2020-07-21 13:08:05 -04:00
|
|
|
|
|
|
|
|
- _testing_
|
|
|
|
|
- _troubleshooting_
|
|
|
|
|
- _debugging_
|
2020-06-20 00:00:01 -04:00
|
|
|
- **Note:** The branch name will be reduced to alphanumeric for consistency and uploading
|
2020-02-05 10:23:47 -05:00
|
|
|
|
2020-02-05 10:25:39 -05:00
|
|
|
## test
|
2020-06-23 15:13:19 -04:00
|
|
|
|
2020-07-21 13:08:05 -04:00
|
|
|
This folder holds all **Test Cases** to help run the _CI/CT/CD_ process for the **Super-Linter**.
|
