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

Report when we're using setup.cfg, .codespellrc, pyproject.toml etc #2534

Closed
sappelhoff opened this issue Oct 17, 2022 · 4 comments · Fixed by #2552
Closed

Report when we're using setup.cfg, .codespellrc, pyproject.toml etc #2534

sappelhoff opened this issue Oct 17, 2022 · 4 comments · Fixed by #2552

Comments

@sappelhoff
Copy link
Contributor

identified in bids-standard/bids-specification#1322 (comment)

How to reproduce:

  • run a basic codespell GH action (without passing with: arguments)
  • add a .codespellrc configuration file to the repo root
  • the config file is being observed BUT
  • the "argument summary" in the GH actions log is not reflecting that

image

@peternewman
Copy link
Collaborator

Pedantically I think that's accurate. If you run the same command locally, without any options, you'd get the same behaviour.

For me as a user that was the thinking too, if I want to recreate it on the command line locally, that's all I should need to know.

@larsoner
Copy link
Member

For consistency and clarity it would be good to say what we're using out of setup.cfg, .codespellrc, pyproject.toml both from the command-line and this action. @sappelhoff up for a PR to codespell first to add it there (probably via some verbosity level if not already present), then the action could just inherit the behavior?

@sappelhoff
Copy link
Contributor Author

I'll put it on my list and will look into it ✔️

@peternewman peternewman transferred this issue from codespell-project/actions-codespell Oct 17, 2022
@peternewman peternewman changed the title Action "summary" of arguments is invalid when configuration is passed Report when we're using setup.cfg, .codespellrc, pyproject.toml etc Oct 17, 2022
@peternewman
Copy link
Collaborator

I've moved this to the main codespell repo now and tweaked the title given it's not directly action specific.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants