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

Add some more options to the flake8 action #9

Merged
merged 7 commits into from
Jun 3, 2020

Conversation

peternewman
Copy link
Contributor

@peternewman peternewman commented May 12, 2020

This also includes #8 .

@peternewman
Copy link
Contributor Author

Hi @TrueBrain ,

Is this good to merge please? This does enough for me to run this against my codebase and I'd rather use the "official" one if possible.

Copy link
Owner

@TrueBrain TrueBrain left a comment

Choose a reason for hiding this comment

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

I am so sorry; for some reason I did not get a notification about this! Happy you gave a poke :) And tnx for this PR, this is awesome :D

One request: would you mind adding a few test cases for this?

So in https://github.com/TrueBrain/actions-flake8/blob/master/example/example.py, make a line of like 90 and 110 chars, set the max length to 100 in https://github.com/TrueBrain/actions-flake8/blob/master/.github/workflows/testing.yml. That should trigger only one. And make an error/warning you put on ignore, so we can see that doesn't happen.

Makes reviewing PRs easier, as that means I can spot if the output is as expected :D

entrypoint.sh Show resolved Hide resolved
@TrueBrain
Copy link
Owner

Owh, and pretty please document these two options in the README.md, so other also know about it :) That would be awesome!

@peternewman
Copy link
Contributor Author

Owh, and pretty please document these two options in the README.md, so other also know about it :) That would be awesome!

🤦 Done. Could do with a way to auto-generate documentation from action.yml files.

@peternewman
Copy link
Contributor Author

I am so sorry; for some reason I did not get a notification about this! Happy you gave a poke :) And tnx for this PR, this is awesome :D

Don't worry, I wasn't sure if you were busy given the current situation.

One request: would you mind adding a few test cases for this?

So in https://github.com/TrueBrain/actions-flake8/blob/master/example/example.py, make a line of like 90 and 110 chars, set the max length to 100 in https://github.com/TrueBrain/actions-flake8/blob/master/.github/workflows/testing.yml. That should trigger only one. And make an error/warning you put on ignore, so we can see that doesn't happen.

Makes reviewing PRs easier, as that means I can spot if the output is as expected :D

I can go one better and nick the good work of @per1234 in codespell-project/actions-codespell#7 and give you some proper tests and CI if you'd like. Or can it wait for another PR?

Here's a live example with those options turned on FWIW:
https://github.com/peternewman/ola/actions/runs/123856886

@TrueBrain
Copy link
Owner

Having a proper CI would be awesome, but indeed something for another PR :)

Btw, often it is better to add a .flake8 file in the repo to set ignores and line length, but I don't mind adding this at all :) more options is better :D

@TrueBrain TrueBrain merged commit ccc113f into TrueBrain:master Jun 3, 2020
@peternewman
Copy link
Contributor Author

Btw, often it is better to add a .flake8 file in the repo to set ignores and line length, but I don't mind adding this at all :) more options is better :D

Thanks, that's good to know and might be easier keeping our Travis CI and GitHub action run config in sync, I guess it depends how much we want to clutter the repo with config files

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.

2 participants