actions/lint
1
0
Fork 0
mirror of https://github.com/super-linter/super-linter.git synced 2024-11-25 23:51:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 31

move CI/CT/CD section to contributing.md

Browse source
This commit is contained in:
Zack Koppert 2020-07-14 17:19:22 -07:00 committed by GitHub
parent 7069ceeef2
commit 7772df028a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
.github/CONTRIBUTING.md vendored
View file

@ -29,6 +29,15 @@ Draft pull requests are also welcome to get feedback early on, or if there is so
- Create a branch with a name that identifies the user and nature of the changes (similar to `user/branch-purpose`) - Create a branch with a name that identifies the user and nature of the changes (similar to `user/branch-purpose`)
- Open a pull request - Open a pull request
### CI/CT/CD
The **Super-Linter** has *CI/CT/CD* configured utilizing **GitHub** Actions.
- When a branch is created and code is pushed, a **GitHub** Action is triggered for building the new **Docker** container with the new codebase
- The **Docker** container is then ran against the *test cases* to validate all code sanity
- `.automation/test` contains all test cases for each language that should be validated
- These **GitHub** Actions utilize the Checks API and Protected Branches to help follow the SDLC
- When the Pull Request is merged to master, the **Super-Linter** **Docker** container is then updated and deployed with the new codebase
- **Note:** The branch's **Docker** container is also removed from **DockerHub** to cleanup after itself
## Releasing ## Releasing
If you are the current maintainer of this action: If you are the current maintainer of this action:
1. If a major version number change: Update `README.md` and the wiki to reflect new version number in the example workflow file sections 1. If a major version number change: Update `README.md` and the wiki to reflect new version number in the example workflow file sections