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

CI: remove potential vale warnings #3806

Merged
merged 2 commits into from
Oct 27, 2023
Merged

CI: remove potential vale warnings #3806

merged 2 commits into from
Oct 27, 2023

Conversation

SMoraisAnsys
Copy link
Collaborator

At least since version 2.29.3 of vale, titles are also checked by vale. Thus, multiple warning started appearing due to non deterministic behavior when using multiple (differently-cased) entries for the same terme.

The proposed solution consists in reworking the accept.txt file until no more warnings are generated.

@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@github-actions github-actions bot added the maintenance Package and maintenance related label Oct 26, 2023
Copy link
Member

@Samuelopez-ansys Samuelopez-ansys left a comment

Choose a reason for hiding this comment

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

Great!

@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

Merging #3806 (c911c0e) into main (7eae896) will increase coverage by 0.02%.
Report is 4 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3806      +/-   ##
==========================================
+ Coverage   81.08%   81.10%   +0.02%     
==========================================
  Files         180      180              
  Lines       62140    62225      +85     
==========================================
+ Hits        50384    50468      +84     
- Misses      11756    11757       +1     

@Samuelopez-ansys
Copy link
Member

@SMoraisAnsys Is this PR still a draft?

@SMoraisAnsys
Copy link
Collaborator Author

@SMoraisAnsys Is this PR still a draft?

Yes, I would like to be sure that everything is working as expected.

@SMoraisAnsys
Copy link
Collaborator Author

I think the changes are working. Since I was not able to get any error, I added some strange sentence in the documentation to trigger vale and only this sentence got caught. Sentence added "Babedibabedibou rofl"

Vale report :

/home/runner/vale --output=/home/runner/work/_actions/errata-ai/vale-action/reviewdog/lib/rdjsonl.tmpl --config=doc/.vale.ini doc
  {"message": "[Vale.Spelling] Did you really mean 'Babedibabedibou'?", "location": {"path": "doc/source/API/Application.rst", "range": {"start": {"line": 31, "column": 1}}}, "severity": "ERROR"}
  {"message": "[Vale.Spelling] Did you really mean 'rofl'?", "location": {"path": "doc/source/API/Application.rst", "range": {"start": {"line": 31, "column": 17}}}, "severity": "ERROR"}

I'll rewrite the history to only keep the changes of interest.
@Samuelopez-ansys Do I change the way the vale work is triggered (either using pyansys action or directly using errata-ai/vale-action@reviewdog) ?

At least since version 2.29.3 of vale, titles are also checked by vale.
Thus, multiple warning started appearing due to non deterministic
behavior when using multiple (differently-cased) entries for the same
terme.

The proposed solution consists in reworking the accept.txt file.
@SMoraisAnsys SMoraisAnsys marked this pull request as ready for review October 27, 2023 09:16
@Samuelopez-ansys
Copy link
Member

@SMoraisAnsys Could we merge?

@Samuelopez-ansys Samuelopez-ansys merged commit d598b7c into main Oct 27, 2023
12 checks passed
@Samuelopez-ansys Samuelopez-ansys deleted the ci/fix_vale branch October 27, 2023 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants