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

Add stickler-CI to test yaml and mkdown files #2238

Merged
merged 2 commits into from
Jun 29, 2022
Merged

Add stickler-CI to test yaml and mkdown files #2238

merged 2 commits into from
Jun 29, 2022

Conversation

yubiuser
Copy link
Member

@yubiuser yubiuser commented Jun 29, 2022

This adds stickler-CI workflow to lint markdown and yaml files.

Uses https://pypi.org/project/yamllint/ and https://github.com/remarkjs/remark-lint internally

@yubiuser yubiuser added PR: Approval Required Open Pull Request, needs approval internal labels Jun 29, 2022
@yubiuser yubiuser requested a review from a team June 29, 2022 11:58
@yubiuser
Copy link
Member Author

This repo needs to be enabled on https://stickler-ci.com/

@PromoFaux
Copy link
Member

Did we not already remove stickler at some point in the past?

@yubiuser
Copy link
Member Author

Searching for stickler PRs did not yield any results.

@rdwebdesign
Copy link
Member

I think it is enabled now.

@yubiuser yubiuser closed this Jun 29, 2022
@yubiuser yubiuser reopened this Jun 29, 2022
Signed-off-by: Christian König <ckoenig@posteo.de>
@rdwebdesign
Copy link
Member

Do you think we need to ignore "vendor" files?

files:
  ignore:
    - '/scripts/vendor/*'

@yubiuser
Copy link
Member Author

It's not complaining now...but maybe does in the future? Shouldn't we report broken styling back to them if errors occur instead of ignoring the files?

@rdwebdesign
Copy link
Member

rdwebdesign commented Jun 29, 2022

I don't think we should do this for external code.

We can report upstream style issues if we found them, but I don't think this should block/delay a PR.

@yubiuser yubiuser marked this pull request as draft June 29, 2022 19:20
@yubiuser
Copy link
Member Author

Converted to draft until we figured out why files are not ignored and if we can fix this.

@yubiuser yubiuser marked this pull request as ready for review June 29, 2022 20:15
Signed-off-by: Christian König <ckoenig@posteo.de>
@yubiuser
Copy link
Member Author

The issue is fixed, files are ignored now as they should.
Reason was the leading / in the paths which is removed now.
This was tested on #2239

@yubiuser yubiuser merged commit 5e02c62 into devel Jun 29, 2022
@yubiuser yubiuser deleted the add_stickler branch June 29, 2022 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PR: Approval Required Open Pull Request, needs approval
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants