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

Introduce a workflow for linting with Vale #29477

Merged
merged 2 commits into from
Dec 8, 2022

Conversation

gsmet
Copy link
Member

@gsmet gsmet commented Nov 24, 2022

Here is the CI setup for Vale.

From what I can see, with fail_on_error: false, the build still fails if Vale complains about something. I think it's probably not a big deal as it's probably a good idea to make people aware of it so that we can fine tune the config.

I'm wondering if it could be useful to ping someone from the doc team (Michelle) for failing Vale workflows? At least once we are confident about the setup? Let me know if you think it has value, I can probably do something about it.

Keeping it as a draft for now as I would like to set up the label we talked about with @michelle-purcell today and send an email to the list before actually enabling it.

Fixes #29103

@quarkus-bot quarkus-bot bot added area/documentation area/infra-automation anything related to CI, bots, etc. that are used to automated our infrastructure labels Nov 24, 2022
@gsmet gsmet force-pushed the doc-vale-workflow branch 2 times, most recently from da92d73 to 692b565 Compare November 24, 2022 16:42
@michelle-purcell
Copy link
Contributor

Thanks @gsmet. I reviewed and replicated the Vale configuration in this PR on my sandbox and see the same behaviour.
fail_on_error: false seems to have no impact.

I will keep digging and testing. It might be a reviewdog v3 issue...

I'll ask about this in the vale-at-red-hat community slack channel, in case this is a known issue.

I really like your label idea. What about the following:

image

Thanks

@gsmet
Copy link
Member Author

gsmet commented Nov 25, 2022

@michelle-purcell I created the label triage/needs-vale-rule-tweak.

@michelle-purcell
Copy link
Contributor

michelle-purcell commented Nov 25, 2022

@gsmet : Thank you. Perfect 💯

I will add information to the quarkus contributor docs to explain what to do when your PR is littered with errors, warnings, or suggestions that are incorrect or misleading.

@michelle-purcell
Copy link
Contributor

@gsmet - According to the Vale docs ⬇️ and issue Action fails even if fail_on_error is false #89, fail_on_error: false is not working as expected. I added our scenario and experience to the issue.

image

@gsmet gsmet marked this pull request as ready for review December 6, 2022 16:54
@gsmet
Copy link
Member Author

gsmet commented Dec 6, 2022

Let's make progress on this even if the situation is not perfect on the Vale side.

@quarkus-bot
Copy link

quarkus-bot bot commented Dec 6, 2022

Failing Jobs - Building 692b565

Status Name Step Failures Logs Raw logs
✔️ JVM Tests - JDK 11
✔️ JVM Tests - JDK 17
JVM Tests - JDK 17 MacOS M1 Set up runner ⚠️ Check → Logs Raw logs
✔️ JVM Tests - JDK 18

@gsmet gsmet merged commit 081664b into quarkusio:main Dec 8, 2022
@quarkus-bot quarkus-bot bot added this to the 2.16 - main milestone Dec 8, 2022
@quarkus-bot quarkus-bot bot added the kind/enhancement New feature or request label Dec 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation area/infra-automation anything related to CI, bots, etc. that are used to automated our infrastructure kind/enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a GitHub action to run the Vale linter to ensure docs are aligned to preferred Quarkus contributor style
3 participants