Skip to content
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.

Sign up for GitHub

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

Jump to bottom

New GitLab CI Component #5675

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

New GitLab CI Component #5675

wants to merge 1 commit into from
+26 −5

Conversation

DarwinJS
Copy link
Contributor

Proposed changes

GitLab CI Components are a new way of extending GitLab with community authored components.

This MR points to the new GitLab CI Component I created to make it super simple to consume Super Linter on GitLab everywhere :)

Readiness checklist

In order to have this pull request merged, complete the following tasks.

Pull request author tasks

  • I included all the needed documentation for this change.
  • I provided the necessary tests.
  • I squashed all the commits into a single commit.
  • I followed the Conventional Commit v1.0.0 spec.
  • I wrote the necessary upgrade instructions in the upgrade guide.
  • If this pull request is about and existing issue,
    I added the Fix #ISSUE_NUMBER label to the description of the pull request.

Super-linter maintainer tasks

  • Label as breaking if this change breaks compatibility with the previous released version.
  • Label as either: automation, bug, documentation, enhancement, infrastructure.

@ferrarimarco ferrarimarco self-assigned this May 21, 2024
@ferrarimarco
Copy link
Collaborator

Hi @DarwinJS !

I'm not familiar with GitLab components.

Can you host them outside GitLab, or do they have to be GitLab repositories?

@ferrarimarco ferrarimarco added documentation Improvements or additions to documentation O: backlog 🤖 Backlog, stale ignores this label labels May 23, 2024
ferrarimarco
ferrarimarco requested changes May 23, 2024
View reviewed changes
Copy link
Collaborator

@ferrarimarco ferrarimarco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR.

This reminded me that we have a few outdated references on this page. I'm addressing this in a separate PR (#5677).

After #5677, can you rebase this on the top of main?

Thanks!

README.md
@@ -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
Copy link
Collaborator

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?

README.md
Comment on lines +156 to +176
## 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.

Copy link
Collaborator

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? Those are GitLab-specific assets that should be addressed in the component's README.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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.

Copy link
Collaborator

Choose a reason for hiding this comment

The 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 run-linter-locally.md file. If we get more traction from GitLab users, we can revisit this.

docs/run-linter-locally.md
@@ -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)
Copy link
Collaborator

Choose a reason for hiding this comment

The 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 super-linter namespace in GitLab, which might lead to readers thinking that the component is part of Super-linter, which is not. Also, it would be nice to add something along these lines to the component's README as well.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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?

Copy link
Collaborator

Choose a reason for hiding this comment

The 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 :)

@ferrarimarco ferrarimarco removed the O: backlog 🤖 Backlog, stale ignores this label label May 28, 2024
@DarwinJS
Copy link
Contributor Author

Hi @DarwinJS !

I'm not familiar with GitLab components.

Can you host them outside GitLab, or do they have to be GitLab repositories?

They have to hosted on a GitLab Instance - but not necessarily GitLab.com. They can be included into GitLab CI jobs that have access to the component (including on runners not associated with the hosting gitlab instance if the component is public).

@ferrarimarco
Copy link
Collaborator

Hi @DarwinJS !
I'm not familiar with GitLab components.
Can you host them outside GitLab, or do they have to be GitLab repositories?

They have to hosted on a GitLab Instance - but not necessarily GitLab.com. They can be included into GitLab CI jobs that have access to the component (including on runners not associated with the hosting gitlab instance if the component is public).

Got it, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ferrarimarco ferrarimarco ferrarimarco requested changes

@zkoppert zkoppert Awaiting requested review from zkoppert zkoppert is a code owner

@Hanse00 Hanse00 Awaiting requested review from Hanse00 Hanse00 is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

@ferrarimarco ferrarimarco

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@DarwinJS @ferrarimarco