-
Notifications
You must be signed in to change notification settings - Fork 964
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New GitLab CI Component #5675
New GitLab CI Component #5675
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -104,7 +104,7 @@ Super-linter supports the following tools: | |
| **XML** | [LibXML](http://xmlsoft.org/) | | ||
| **YAML** | [YamlLint](https://github.com/adrienverge/yamllint) | | ||
|
||
## Get started | ||
## Get started with GitHub | ||
|
||
More in-depth [tutorial](https://www.youtube.com/watch?v=EDAmFKO4Zt0&t=118s) available | ||
|
||
|
@@ -153,6 +153,27 @@ To run super-linter as a GitHub Action, you do the following: | |
1. Push the new commit to the remote repository. | ||
1. Create a new pull request to observe the results. | ||
|
||
## Get started with GitLab | ||
|
||
To run super-linter as a GitLab CI Component, you do the following: | ||
|
||
1. Add the following to a .gitlab-ci.yml: | ||
|
||
```yaml | ||
include: | ||
- component: gitlab.com/components/super-linter/super-linter@1.2.0 | ||
``` | ||
|
||
1. Commit the changed .gitlab-ci.yml. | ||
|
||
### GitLab Details | ||
|
||
If you are in a branch with a Merge Request, the report results file will create a new heading in the MR called "Super Linter Test Results" | ||
|
||
The documentation and latest available component version is here: https://gitlab.com/explore/catalog/guided-explorations/ci-components/super-linter | ||
|
||
The documentation contains some information on how to customize the Super Linter options. | ||
|
||
Comment on lines
+156
to
+176
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you revert this change? Those are GitLab-specific assets that should be addressed in the component's README. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ok. I was under the impression the project was trying to be completely open source - so not necessarily a preference for GitHub? So was hoping improve the visibility since the mentions in run-linter-locally.md are rather off the beaten path? Was also putting "how to include" information on parity with GitHub? Brief, but complete enough for quick success. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Given that the vast majority of users run this on GitHub Actions, for now we can keep this in the |
||
## Upgrade to newer super-linter versions | ||
|
||
For more information about upgrading super-linter to a new major version, see | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,7 +33,7 @@ Check out this [article](https://blog.tyang.org/2020/06/27/use-github-super-lint | |
|
||
### 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) | ||
Check out this GitLab CI Component which only requires a single line of code: [GitLab CI Component for Super-Linter](https://gitlab.com/explore/catalog/guided-explorations/ci-components/super-linter) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should refactor this sentence to avoid confusion, given that you used the Can you refactor this sentence to: Alternatively, you can this GitLab CI/CD component. Note that this component is not designed, implemented, or maintained by Super-linter's maintainers. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sure - I was just following what was there. So is this out of the way place the only allowable mention of the GitLab support then? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wouldn't put this in terms of "allowable mentions", as I explained above :) |
||
|
||
### Run on Codespaces and Visual Studio Code | ||
|
||
|
@@ -62,9 +62,9 @@ them accordingly: | |
``` | ||
|
||
1. Load the super-linter configuration file when running in GitHub Actions by | ||
adding the following step to the GitHub Actions workflow that runs | ||
super-linter, after checking out your repository and before running | ||
super-linter: | ||
adding the following step to the GitHub Actions workflow that runs | ||
super-linter, after checking out your repository and before running | ||
super-linter: | ||
|
||
```yaml | ||
- name: Load super-linter configuration | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you revert this change?