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

vale #3147

Closed
wants to merge 2 commits into from
Closed

vale #3147

wants to merge 2 commits into from

Conversation

evgeni
Copy link
Member

@evgeni evgeni commented Jul 18, 2024

  • Vale
  • testing
  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.11/Katello 4.13
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • Foreman 3.6/Katello 4.8
  • Foreman 3.5/Katello 4.7 (Satellite 6.13; orcharhino 6.6/6.7)
  • We do not accept PRs for Foreman older than 3.5.

Copy link

github-actions bot commented Jul 18, 2024

The PR preview for 2ce46e7 is available at theforeman-foreman-documentation-preview-pr-3147.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

We have an excessive symlink farm pointint at guides/common, vale
rescans that every time when scanning the individual guides, which makes
it super slow (35min on my laptop), excluding the links in guides/doc-*
makes it quite fast (90sec on my latop) as it now only scans
guides/common once.

Also exclicitly use the github-pr-annotations reporter, which works w/o
elevated GITHUB_TOKEN privileges and thus also from forked repos.
- uses: errata-ai/vale-action@reviewdog
with:
filter_mode: diff_context
vale_flags: "--no-exit --minAlertLevel=error --glob=!*/doc-*/common/*"
Copy link
Contributor

Choose a reason for hiding this comment

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

*.adoc will prevent the sym links problem

Copy link
Member Author

Choose a reason for hiding this comment

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

you mean --glob=*.adoc?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes

Copy link
Member Author

Choose a reason for hiding this comment

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

Doesn't work for me locally.

Running it with --glob='*.adoc' (quoted, so my shell doesn't interpret the *) and it spins for minutes now.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, I misread your earlier comment. No, I meant this: --glob=!*/doc-*/common/*.adoc"

Copy link
Contributor

Choose a reason for hiding this comment

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

but now I'm not certain. I have not used that flag.

vale_flags: "--no-exit --minAlertLevel=error --glob=!*/doc-*/common/*"
# github-pr-annotations doesn't require elevated token privileges
reporter: github-pr-annotations
fail_on_error: true
Copy link
Member

Choose a reason for hiding this comment

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

It has annotations, but the check doesn't appear to fail. That's confusing to me.

@ekohl
Copy link
Member

ekohl commented Jul 25, 2024

#3145 was merged.

@ekohl ekohl closed this Jul 25, 2024
@evgeni evgeni deleted the vale branch July 25, 2024 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants