feat(ci): Add codespell to Makefile and GitHub Actions #3996
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a followup from open-telemetry#3980 to add the automation for checking for code spelling errors to a different PR. [Codespell][] makes use of the `.codespellrc` file automatically as a config file for convenience. The configuration file specifies directories and flags to pass to `codespell`. Codespell also makes use of the `.codespellignore` file to ignore certain word spellings. There is a new section in `Makefile` for installing python tooling. It is similar to how the go tools are installed. It sets up a virtualenv in `venv `and installs python tooling there if it hasn't been installed yet. The new [codespell workflow][] will run in pull requests to annotate misspelled words. It is set up to only warn the user with annotations in the pull request if there are typos, but we can fail the pull request as well if we want to by deleting the [warn_only][] key. [codespell]: https://github.com/codespell-project/codespell [codespell workflow]: https://github.com/codespell-project/actions-codespell [warn_only]: https://github.com/codespell-project/actions-codespell#parameter-only_warn
CharlieTLe
requested review from
jmacd,
MrAlias,
Aneurysm9,
evantorrie,
XSAM,
dashpole,
MadVikingGod,
pellared,
hanyuancheung and
dmathieu
as code owners
MrAlias
reviewed
Apr 13, 2023
MrAlias
reviewed
Apr 13, 2023
Since this is a Go project, having a dependency on python seemed disconcerting. So, docker is used to create a virtual environment with a python image and also run the tools that were installed.
dmathieu
reviewed
Apr 19, 2023
Co-authored-by: Damien Mathieu <[email protected]>
dmathieu
approved these changes
Apr 20, 2023
|
Thanks for approving @dmathieu! Since I don't have write access, could someone help merge the PR? |
hanyuancheung
approved these changes
Apr 24, 2023
pellared
reviewed
Apr 24, 2023
pellared
reviewed
May 8, 2023
Co-authored-by: Robert Pająk <[email protected]>
|
@pellared Updated the GH action to use |
CharlieTLe
added a commit
to CharlieTLe/opentelemetry-go-build-tools
that referenced
this pull request
May 9, 2023
requirements.txt files will now be tracked with dependabot. This is related to open-telemetry/opentelemetry-go#3996.
pellared
approved these changes
May 10, 2023
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #3996 +/- ##
=======================================
- Coverage 83.4% 83.3% -0.1%
=======================================
Files 181 181
Lines 13925 13925
=======================================
- Hits 11614 11610 -4
- Misses 2090 2094 +4
Partials 221 221 |
|
Thanks for reviewing @pellared. Can anyone with the 🪄 help merge this PR? |
MrAlias
reviewed
May 17, 2023
MrAlias
reviewed
May 17, 2023
MrAlias
approved these changes
May 18, 2023
MrAlias
added a commit
to open-telemetry/opentelemetry-go-build-tools
that referenced
this pull request
May 22, 2023
* Add pip to dbotconf requirements.txt files will now be tracked with dependabot. This is related to open-telemetry/opentelemetry-go#3996. * Create struct for updates * Update dbotconf/internal/verify_test.go Co-authored-by: Robert Pająk <[email protected]> * fix shadow declaration of "updates" * Generate change log * Update .chloggen/pip.yaml * Update dbotconf/internal/conf.go Co-authored-by: Tyler Yahn <[email protected]> * Update dbotconf/internal/testdata/dependabot.yml --------- Co-authored-by: Robert Pająk <[email protected]> Co-authored-by: Tyler Yahn <[email protected]>
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a followup from
#3980 to add the automation for checking for code spelling errors to a different PR.
Codespell makes use of the
.codespellrcfile automatically as a config file for convenience. The configuration file specifies directories and flags to pass tocodespell. Codespell also makes use of the.codespellignorefile to ignore certain word spellings.There is a new section in
Makefilefor installing python tooling. It is similar to how the go tools are installed. It sets up a virtualenv invenvand installs python tooling there if it hasn't been installed yet.The new codespell workflow will run in pull requests to annotate misspelled words. It is set up to only warn the user with annotations in the pull request if there are typos, but we can fail the pull request as well if we want to by deleting the only_warn key.
cc: @pellared @MrAlias @dmathieu @alolita