actions/superlint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-12-22 15:22:16 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #50 from github/docs

Browse source 
adding doc
This commit is contained in:
Lukas Gravley 2020-01-09 14:29:28 -06:00 committed by GitHub
commit 77ff43a955
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
.automation/README.md Normal file
View 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