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

Clarification need for linting response severity #76

Closed
Kevsy opened this issue Oct 16, 2023 · 2 comments
Closed

Clarification need for linting response severity #76

Kevsy opened this issue Oct 16, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Kevsy
Copy link
Collaborator

Kevsy commented Oct 16, 2023

Problem description
The linting process in PR #74 can result in errors/warnings. We should discuss what is the expected outcome for each severity. For example should "warn" result in a change and re-lint, or can it be ignored?

Quoting Herbert's comment from the PR #74 discussion
@hdamker hdamker Oct 12, 2023

Good point. Maybe we can differentiate along the following lines:

warnings can be ignored when introducing linting first time
    OR (alternative) warnings can be ignored if correcting them would introduce a breaking change
warnings shall not be introduced with a change (e.g. within a merge, that's the point where linting is done)

Expected action
Agree the expected action for errors/warnings for the linring process.

Additional context
See #74

@Kevsy Kevsy added the documentation Improvements or additions to documentation label Oct 16, 2023
@rartych
Copy link
Collaborator

rartych commented Feb 22, 2024

I propose to close this issue.
The severity of each rule can be modified in .spectral.yml file if needed.
The respective guidelines for linting results utilization should be prepared as a part of Release Management process definition.

Note: With Megalinter as an umbrella for all dedicated linting tools warnings are ignored: if there is no error then the log is empty. To check for warnings in such case additional workflow can be started manually.

@rartych
Copy link
Collaborator

rartych commented Apr 15, 2024

We can come back to the issue while extending the ruleset.

@rartych rartych closed this as completed Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants