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

Establish whether we want to bring codespell into our infrastructure repo #3189

Closed
2 tasks
sgibson91 opened this issue Sep 28, 2023 · 9 comments
Closed
2 tasks
Assignees

Comments

@sgibson91
Copy link
Member

Context

We have received a contribution to include codespell into our pre-commit configuration: https://github.com/2i2c-org/infrastructure/pull/3098/files#diff-63a9c44a44acf85fea213a857769990937107cf072831e1a26808cfde9d096b9
I asked in Slack a while ago what to do about this PR but the thread wasn't followed through on: https://2i2c.slack.com/archives/C055A1J1DRP/p1694510304452379
The PR author has asked whether we are considering such a contribution before they work to resolve some conflicts.

Proposal

No response

Updates and actions

  • Assess codespell as a risk to our infrastructure
  • Merge or politely decline the PR as necessary
@damianavila
Copy link
Contributor

@2i2c-org/engineering, I encourage you to provide your feedback on this one so we can achieve consensus in the next few days and have a definetive response for the PR author as soon as possible.

@damianavila
Copy link
Contributor

Another ping to @2i2c-org/engineering, we need to reach some agreement on this one so we can communicate back to the PR submitter as soon as possible.

@sgibson91
Copy link
Member Author

I personally don't see any reason why not. Seems codespell has been shipping with ubuntu since at least 20.04 https://manpages.ubuntu.com/manpages/focal/man1/codespell.1.html

@consideRatio
Copy link
Member

I open to trying it if I first evaluate security brielfly. I'll do that tomorrow.

I've hesitated as this is a prompt to (via pre-commit) run software on our computers. That made me a bit cautious and want to look into if i trust the software to be run. I've also hesitated by past experience with language checkers causing noise.

@damianavila damianavila moved this from Todo 👍 to In Progress ⚡ in Sprint Board Oct 3, 2023
@damianavila damianavila moved this from Needs Shaping / Refinement to In progress in DEPRECATED Engineering and Product Backlog Oct 3, 2023
@damianavila damianavila moved this from In Progress ⚡ to Waiting 🕛 in Sprint Board Oct 6, 2023
@damianavila
Copy link
Contributor

There was a recent push on the PR: #3098 (comment) and we need to provide the PR author with feedback.

I open to trying it if I first evaluate security brielfly. I'll do that tomorrow.

If this is taking a significant amount of time (more than 30 min), I would advocate closing the PR without merging it.

@yuvipanda
Copy link
Member

Did some research and wrote out #3098 (review)

@sgibson91
Copy link
Member Author

run software on our computers

This security concern is also based on the assumption that all of us have set up the pre-commit hooks locally, which is not true. I think if it's safe enough to run in CI, then we should merge it. Installing hooks locally can be at the individual's discretion.

@sgibson91
Copy link
Member Author

sgibson91 commented Jan 30, 2024

Just flagging from the review @yuvipanda made:

So I think this is good to go. Unless there are objections from anyone, I'll (Yuvi) merge this next Wednesday (Jan 31)

(I added clarification on who 'I' is in the quote :) )

@sgibson91
Copy link
Member Author

PR was merged 🎉

@github-project-automation github-project-automation bot moved this from Waiting 🕛 to Done 🎉 in Sprint Board Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done 🎉
Development

No branches or pull requests

4 participants