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

docs: update gitlab and azure docs (#5677)

Browse source 
- Remove outdated Azure and GitLab references.
- Add a basic GitLab example.
This commit is contained in:
Marco Ferrari 2024-05-24 02:52:33 +02:00 committed by GitHub
parent df39abd805
commit c5e4fe14a1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/run-linter-locally.md
View file

@ -27,13 +27,24 @@ Notes:
- If you want to override the `/tmp/lint` folder, you can set the `DEFAULT_WORKSPACE` environment variable to point to the folder you'd prefer to scan.
- You can add as many configuration options as needed. Configuration options are documented in the [README](../README.md#configure-super-linter).
### Azure
Check out this [article](https://blog.tyang.org/2020/06/27/use-github-super-linter-in-azure-pipelines/)
### GitLab
Check out this [snippet](https://gitlab.com/snippets/1988376) and this Guided Exploration: [GitLab CI CD Extension for Super-Linter](https://gitlab.com/guided-explorations/ci-cd-plugin-extensions/ci-cd-plugin-extension-github-action-super-linter)
To run Super-linter in your GitLab CI/CD pipeline, You can use the following
snippet:
```yaml
super-linter:
# More info at https://github.com/super-linter/super-linter
stage: Super-linter
# Use a specific Super-linter version instead of latest for more reproducible builds
image: super-linter/super-linter:latest
script: [ "true" ]
variables:
RUN_LOCAL: "true"
DEFAULT_WORKSPACE: $CI_PROJECT_DIR
```
Note that this is a high-level example that you should customize for your needs.
### Run on Codespaces and Visual Studio Code