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

Added editorial style guide checking. #620

Merged
merged 4 commits into from
Oct 24, 2024
Merged

Conversation

dblock
Copy link
Member

@dblock dblock commented Oct 17, 2024

Description

Add support for running Vale on specs. This gets us reviews of .yaml files being changed.

image

Issues Resolved

Closes #599.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

github-actions bot commented Oct 17, 2024

Changes Analysis

Commit SHA: 93c1b65
Comparing To SHA: 110474f

API Changes

Summary

NO CHANGES

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/11507315122/artifacts/2101233351

API Coverage

Before After Δ
Covered (%) 588 (57.59 %) 588 (57.59 %) 0 (0 %)
Uncovered (%) 433 (42.41 %) 433 (42.41 %) 0 (0 %)
Unknown 30 30 0

@dblock dblock force-pushed the vale branch 5 times, most recently from 8d9f61e to e22d550 Compare October 17, 2024 17:39
Copy link

github-actions bot commented Oct 17, 2024

Spec Test Coverage Analysis

Total Tested
505 318 (62.97 %)

@dblock
Copy link
Member Author

dblock commented Oct 21, 2024

@kolchfa-aws please take a look, this is ready to be merged

@dblock dblock force-pushed the vale branch 2 times, most recently from 87b7199 to 2cd1f8a Compare October 21, 2024 19:37
Copy link
Contributor

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

I noted that we can remove several rules from here because they are not needed. Otherwise, LGTM

.github/vale/styles/OpenSearch/LinksDoubleParentheses.yml Outdated Show resolved Hide resolved
.github/vale/styles/OpenSearch/LinksDoubleSlash.yml Outdated Show resolved Hide resolved
.github/vale/styles/OpenSearch/LinksEndSlash.yml Outdated Show resolved Hide resolved
.github/vale/styles/OpenSearch/LinksMidSlash.yml Outdated Show resolved Hide resolved
.github/vale/styles/OpenSearch/MergeConflicts.yml Outdated Show resolved Hide resolved
.github/vale/styles/OpenSearch/HeadingCapitalization.yml Outdated Show resolved Hide resolved
.github/vale/styles/OpenSearch/HeadingColon.yml Outdated Show resolved Hide resolved
.github/vale/styles/OpenSearch/HeadingPunctuation.yml Outdated Show resolved Hide resolved
.vale.ini Outdated Show resolved Hide resolved
.vale.ini Show resolved Hide resolved
@dblock
Copy link
Member Author

dblock commented Oct 22, 2024

@nhtruong care to CR when you get a chance, please?

Signed-off-by: Theo N. Truong <[email protected]>
Copy link
Collaborator

@nhtruong nhtruong left a comment

Choose a reason for hiding this comment

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

The ability to pinpoint exactly where the error happens with git diff is so nice. We should add this to the spec linter in the future!

@nhtruong nhtruong merged commit 61e6ec3 into opensearch-project:main Oct 24, 2024
22 checks passed
@dblock dblock deleted the vale branch October 24, 2024 21:01
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.

[FEATURE]Implement vocabulary and spelling linter in this repo
3 participants