Skip to content

Fix pipelines: [docs] Adjust Vale Doc Linter and Prettier configurations Issue #517

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

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

pratik-mahalle
Copy link

What has changed?
This pull request addresses the issues with failing Vale Doc Linter and Prettier pipelines as described in Issue #2696.

  • Fixed numerous spelling and style errors flagged by Vale across the documentation files.
  • Corrected branch/tag references in the Prettier pipeline configuration.

Type of change

  • Bug fix (non-breaking change which fixes an issue).

@pratik-mahalle pratik-mahalle requested a review from nehagup as a code owner May 16, 2025 06:20
Copy link

keploy bot commented May 16, 2025

Nice Pr 😄. We currently support Unit Test Generation only for Go projects.
Stay tuned – support for more languages is coming soon! 🚀

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you and congratulations 🎉 for opening your very first pull request in keploy

@pratik-mahalle pratik-mahalle changed the title Fix pipelines: [docs] Adjust Vale Doc Linter and Prettier configurations Issue #2696 Fix pipelines: [docs] Adjust Vale Doc Linter and Prettier configurations Issue May 16, 2025
@Achanandhi-M
Copy link
Contributor

Hi @pratik-mahalle, thanks for raising the PR!
I’m a bit confused about the number of files changed—especially since the issue seems to be related to a linter problem. Could you please elaborate on the changes, particularly why files like vale_styles/Google/GenderBias.yml were modified? It would help me better understand the context of the PR. Thanks!

@pratik-mahalle
Copy link
Author

Hey @Achanandhi-M, Thank you for the review. I think, the main goal of this PR was to adjust the Vale Doc Linter and Prettier configurations to resolve the linter issues we were encountering. As part of this, I needed to update some of the custom style files, including vale_styles/Google/GenderBias.yml, to ensure they aligned with our current linting rules and addressed the specific problems flagged by Vale.

@Achanandhi-M
Copy link
Contributor

I’ll get it reviewed by the team and follow up on the merge soon @pratik-mahalle

@khareyash05
Copy link
Member

The pipelines are still failing @pratik-mahalle

@pratik-mahalle
Copy link
Author

pratik-mahalle commented May 21, 2025

Hey @khareyash05 , In vale-lint-action.yml only the versioned_docs/version-2.0.0 directory is checked. Are we want to check only that folder?

@pratik-mahalle
Copy link
Author

Let me try pushing the recent changes, if it works!

@Achanandhi-M
Copy link
Contributor

The pipelines are still failing @pratik-mahalle

@pratik-mahalle
Copy link
Author

Ok, Looks like some changes got merged in the repo due to which it is failing. I will fix it

pratik-mahalle and others added 12 commits May 31, 2025 11:02
…go types - Fix ordinal numbers and unit spacing - Fix quote punctuation - Fix em dash spacing

Signed-off-by: Pratik Mahalle <[email protected]>
…go types - Fix ordinal numbers and unit spacing - Fix quote punctuation - Fix em dash spacing

Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
* feat: Added Openhospital docs

Signed-off-by: Achanandhi-M <[email protected]>

* feat: Added Openhospital docs

Signed-off-by: Achanandhi-M <[email protected]>

---------

Signed-off-by: Achanandhi-M <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Achanandhi-M <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Co-authored-by: Tvisha Raji <[email protected]>
Co-authored-by: Neha Gupta <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Co-authored-by: Mridul Tripathi <[email protected]>
Signed-off-by: Chirag Ghosh <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Chirag Ghosh <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
@pratik-mahalle
Copy link
Author

Hey @Achanandhi-M, I have fixed the errors and it shows me no errors, I hope it will work now.
Thanks!

@Achanandhi-M
Copy link
Contributor

Hey @pratik-mahalle,
This is really amazing! I’ll ask my team to do a final review.

@pratik-mahalle
Copy link
Author

I am not sure why Prettify code pipelines are failing, If you know please let me know @Achanandhi-M

@Achanandhi-M
Copy link
Contributor

Achanandhi-M commented May 31, 2025

Hey @pratik-mahalle,

The reason the lint action failed is due to this issue: "subject must not be sentence-case, start-case, pascal-case, or upper-case [subject-case]".

In your commit, the subject line uses uppercase, which is why it’s failing.

Also, the Prettier code error seems to be related to a permission issue. Just checking—did you run the npx prettier --write '**/*.{js,md}' command before pushing?

Let me know if you need any help!

@pratik-mahalle
Copy link
Author

pratik-mahalle commented Jun 3, 2025

Hey @pratik-mahalle,

The reason the lint action failed is due to this issue: "subject must not be sentence-case, start-case, pascal-case, or upper-case [subject-case]".

In your commit, the subject line uses uppercase, which is why it’s failing.

Also, the Prettier code error seems to be related to a permission issue. Just checking—did you run the npx prettier --write '**/*.{js,md}' command before pushing?

Let me know if you need any help!

Yeah, I run the prettier --write . and then I commit the changes, will it change anything?

@Achanandhi-M
Copy link
Contributor

Sorry @pratik-mahalle , You can see again it is failing

@pratik-mahalle
Copy link
Author

pratik-mahalle commented Jun 3, 2025

Yeah, one is failing due to permission and another one is failing due to the commit syntax I think. Can you tell me what could be the reason behind that lint-codebase pipeline failure

@pratik-mahalle
Copy link
Author

I have update the commit message and add the required permission also, let`s check if it work or not @Achanandhi-M

@Achanandhi-M
Copy link
Contributor

Sorry @pratik-mahalle,
It’s still failing. Please give me some time to figure out why. Maybe if we close this PR and create a new one with the update commits message, the commit message issues might be resolved—but I’m not entirely sure yet.

@pratik-mahalle
Copy link
Author

Okay @Achanandhi-M , I am also figuring it out. Let me know if you find a solution.

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.

5 participants