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

[Feature Request] Suggested way of automating this with CI jobs #7

Open
joohoi opened this issue Jun 5, 2018 · 5 comments
Open

[Feature Request] Suggested way of automating this with CI jobs #7

joohoi opened this issue Jun 5, 2018 · 5 comments

Comments

@joohoi
Copy link

joohoi commented Jun 5, 2018

Is there a suggested way of running this as a static part of the workflow with Travis-CI for example? I feel that a hard fail would probably be too error prone, but something that would easily note that there might be spelling issues in the state of repo.

I really like how https://coveralls.io API can report back to GitHub issues, but I do acknowledge that this would mean running an static instance outside of Travis to handle the reporting.

Sorry for kind of open ended issue and rambling.

@joohoi joohoi changed the title Suggested way of automating this with CI jobs [Feature Request] Suggested way of automating this with CI jobs Jun 5, 2018
@jsoref
Copy link
Owner

jsoref commented Jun 28, 2018

I've written: https://github.com/checkstyle/checkstyle/blob/master/.ci/test-spelling-unknown-words.sh which interacts with Travis.

@jsoref
Copy link
Owner

jsoref commented Jan 6, 2019

A GitHub App/check/probot thing is definitely intriguing. I'm thinking about it a bit, but I haven't gone very far w/ it...

@henryiii
Copy link

henryiii commented Feb 12, 2020

A GitHub Action would be very interesting. See pre-commit's GHA, for example.

Edit: Actually, a pre-commit plugin or example would be great, see https://pre-commit.com. Then it would just take advantage of the existing pre-commit GHA and local usage, too.

@jsoref
Copy link
Owner

jsoref commented Feb 12, 2020

I've actually started working on this... It will eventually be in this repository.
For the time being, you can see the Action here:
https://github.com/jsoref/spelling-action
And a consumer here:
https://github.com/jsoref/test-test
With a sample runs:
https://github.com/jsoref/test-test/actions/runs/37887629

@jsoref
Copy link
Owner

jsoref commented Dec 31, 2020

@henryiii: this year I've released a number of alpha releases of check-spelling

As for a pre-commit hook, I'm actually getting close to being able to do that... Although It isn't a direct goal.

A pre-release version of the action supports nektos/act, so one could use that.

But something more lightweight could be implemented using the toolchain I'm using to clean up repositories before submitting PRs...

I think I'll probably close this once my action is closer to a 1.0 release, or at least when I stop calling it "alpha".

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

No branches or pull requests

3 participants