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.

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

feat: enable markdown linter for kits #674

Merged
merged 1 commit into from
Feb 16, 2024

Conversation

mhellmeier
Copy link
Member

Description

This PR enables the markdown linter for the KITs.

Fixes #673

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@mhellmeier mhellmeier added the enhancement New feature or request label Feb 15, 2024
Copy link
Contributor

@SebastianBezold SebastianBezold left a comment

Choose a reason for hiding this comment

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

👍 I think it is the best option to merge it, even with failing check. These issues did pile up due to the lack of linting and should now be worked on collectively.

Separate issues per KIT would be fine in my opinion.

@mhellmeier mhellmeier merged commit 8100e33 into eclipse-tractusx:main Feb 16, 2024
4 of 5 checks passed
@mhellmeier mhellmeier deleted the feat/enable-linter branch February 16, 2024 13:47
@maximilianong
Copy link
Contributor

maximilianong commented Feb 19, 2024

Looks like all open PRs are now failing due to this new rule. How to handle this? Should we inform now the responsible of every KIT to resolve their issues?

@arnoweiss
Copy link
Contributor

I don't have fundamental problems with merging despite a failed linter check. But there should be a requirement that every update to every kit fixes THEIR issues for ALL releases.

@mhellmeier
Copy link
Member Author

Looks like all open PRs are now failing due to this new rule. How to handle this? Should we inform now the responsible of every KIT to resolve their issues?

Exactly, @maximilianong! Every KIT has to fix its linting errors. @SebastianBezold and I are planning to create a GitHub Issue for every KIT. It is important that this will be checked during the Quality Gates.

I don't have fundamental problems with merging despite a failed linter check. But there should be a requirement that every update to every kit fixes THEIR issues for ALL releases.

The first part is correct, @arnoweiss: While the KIT developers are fixing their linting problems, merging with a failed pipeline is okay. For the second part: Since the current pipeline only checks the docs and the docs-kits folder and not the docs-kits_versioned_docs, only the current and future KIT versions need to be corrected. Fixing the old archived versions would be great, but is still optional.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Markdown Quality by Enabling the Linter
5 participants