mirror of
https://github.com/super-linter/super-linter.git
synced 2024-11-09 02:23:39 -05:00
adding doc
This commit is contained in:
parent
99cf75c85b
commit
f163bb8b27
1 changed files with 19 additions and 0 deletions
19
.automation/README.md
Normal file
19
.automation/README.md
Normal file
|
@ -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
|
Loading…
Reference in a new issue