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

Updates to github action #765

Merged
merged 1 commit into from
Oct 30, 2024
Merged

Conversation

kprosise
Copy link
Contributor

The action for the linter now requires dependencies to be installed for markup languages other than markdown.

Unable to easily test locally, but does not effect ability to build or publish docs.

No related issue/ticket, general maintenance task

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Overview

Recent changes to the github action/reviewdog for the Vale linter means it has been failing. This is caused from dependencies that now need to be installed.

Checklist

  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

May fail due to syntax/order which was not made clear.

The action for the linter now requires dependencies to be installed for
markup languages other than markdown.

Unable to easily test locally, but does not effect ability to build or
publish docs.

No related issue/ticket, general maintenance task

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise requested a review from a team October 30, 2024 09:34
@doanac
Copy link
Member

doanac commented Oct 30, 2024

@kprosise kprosise merged commit 00463b8 into foundriesio:main Oct 30, 2024
2 of 3 checks passed
@kprosise kprosise deleted the update-reviewdog branch October 30, 2024 10:24
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.

2 participants