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

Use Vale (or some other tool) to check for style in a github action? #236

Closed
lwasser opened this issue Apr 9, 2024 · 5 comments · Fixed by #281
Closed

Use Vale (or some other tool) to check for style in a github action? #236

lwasser opened this issue Apr 9, 2024 · 5 comments · Fixed by #281
Labels
help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable

Comments

@lwasser
Copy link
Member

lwasser commented Apr 9, 2024

Is this possible? see comment below frm me in an open pr!

FUTURE IDEA: This is of course for another issue / PR BUT there is this tool I use locally called Vale that @Batalex turned me on to. it's nice because you can create your own style guide. i wonder if there is a way to set this up as a ci check for the organization in the future? we could then have the style guide information in a single repo and use it across all of our repositories.

Originally posted by @lwasser in #224 (comment)

@lwasser
Copy link
Member Author

lwasser commented Apr 9, 2024

referenced in #224

@lwasser
Copy link
Member Author

lwasser commented Apr 9, 2024

this actually already exists - https://github.com/errata-ai/vale-action we'd just need to figure out how / where to store the styleguide files (essentially text files that tell it what to look for and what to update / fix.

@willingc
Copy link
Collaborator

willingc commented Apr 9, 2024

Pretty sure that I have used vale in CI in the past @lwasser.

@lwasser
Copy link
Member Author

lwasser commented Apr 9, 2024

awesome @willingc your expertise would be great!!

what keeps coming up (and @kierisi has caught this too) is spelling things like PyPI pypi, test pypi testPyPI etc differently. we could create a setup that would implement / check for consistency of capitalization and spelling in CI and have a process where whenever we find a new word spelled or cased differently we can add it to the pyos styles.

@lwasser lwasser added help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable labels Apr 9, 2024
@lwasser lwasser moved this to Dev Ops / GitHub actions or GitHub related in pyOpenSci Help Wanted Project Board Apr 9, 2024
@flpm
Copy link
Member

flpm commented May 20, 2024

I am going to look into this issue (PyCon US 2024 sprints)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted We welcome a contributor to work on this issue! thank you in advance! sprintable
Projects
Development

Successfully merging a pull request may close this issue.

3 participants