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 docs checks to GH workflows #1845

Merged
merged 3 commits into from Oct 24, 2023
Merged

Conversation

rkratky
Copy link
Contributor

@rkratky rkratky commented Oct 19, 2023

This adds the following automated docs checks to GH Actions:

  • spellcheck
  • linkcheck
  • inclusive-language check

(Fixes FR-5662)

@rkratky rkratky force-pushed the FR-5662_docs-checks branch 2 times, most recently from c489f54 to b5b1627 Compare October 19, 2023 14:42
Copy link
Collaborator

@dbungert dbungert left a comment

Choose a reason for hiding this comment

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

This should be fine. But as the tests are failing at the moment I'm curious to see the final result.

@rkratky rkratky marked this pull request as draft October 20, 2023 08:30
@rkratky
Copy link
Contributor Author

rkratky commented Oct 22, 2023

I fixed the invocation of the test (inclusive lang.) that failed to run, and it's now running and passing.

The last failing test is spellcheck, which is fixed by #1847 (when that PR is merged, the spellcheck should be passing).

@rkratky rkratky marked this pull request as ready for review October 23, 2023 16:07
@dbungert
Copy link
Collaborator

I am cancelling and restarting the stuck jobs.

@dbungert
Copy link
Collaborator

The spelling check failed on 2 items, however they don't fail when run locally. I presume there is a slight difference in the dictionaries between the two test run cases.

I have pushed a commit with proposed fixes for these, please incorporate or re-implement as you see fit, @rkratky .

@rkratky
Copy link
Contributor Author

rkratky commented Oct 24, 2023

Thanks, @dbungert. Merging with your commit as is.

(Though I cannot fathom what dictionary could exclude 'boolean'... And for 'runtime', most style guides allow for both forms ('runtime' and 'run time'), so I'll add it to the wordlist in the next iteration, too.)

@rkratky rkratky merged commit 41114a0 into canonical:main Oct 24, 2023
13 checks passed
@rkratky rkratky deleted the FR-5662_docs-checks branch October 24, 2023 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants