Add codespell: workflow, by yarikoptic · Pull Request #1888 · GoogleCloudPlatform/cluster-toolkit

yarikoptic · 2023-10-26T14:44:01Z

Submission Checklist

Please take the following actions before submitting this pull request.

Fork your PR branch from the Toolkit "develop" branch (not main)
Test all changes with pre-commit in a local branch #. If running with -a codespell triggers since then pre-commit passes all file names and thus excludes in .codespellrc do not apply. Should I do anything about that?
Confirm that "make tests" passes all tests
Follow Cloud HPC Toolkit Contribution guidelines #

nick-stroud

Thank you for the submission and apologies that this has sit for a while.

Please make the requested changes and then un-assign yourself from the PR.

nick-stroud · 2023-11-22T23:36:40Z

/gcbrun

yarikoptic · 2023-11-24T19:57:04Z

Please make the requested changes and then un-assign yourself from the PR.

done! also rebased and reran the codespell -w last commit -- there were new typos (or just new detected with newer codespell I used)

Here is the interdiff between those two showing new fixups

❯ interdiff -U1 <(git show gh-yarikoptic/enh-codespell) <(git show enh-codespell)
diff -U1 b/community/front-end/ofe/website/ghpcfe/views/credentials.py b/community/front-end/ofe/website/ghpcfe/views/credentials.py
--- b/community/front-end/ofe/website/ghpcfe/views/credentials.py
+++ b/community/front-end/ofe/website/ghpcfe/views/credentials.py
@@ -130,3 +130,3 @@
 class CredentialViewSet(viewsets.ModelViewSet):
-    """Custom ModelViewSet for Crendential model"""
+    """Custom ModelViewSet for Credential model"""
 
diff -U1 b/community/modules/compute/gke-job-template/variables.tf b/community/modules/compute/gke-job-template/variables.tf
--- b/community/modules/compute/gke-job-template/variables.tf
+++ b/community/modules/compute/gke-job-template/variables.tf
@@ -41,3 +41,3 @@
 variable "node_pool_name" {
-  description = "A list of node pool names on which to run the job. Can be populated via `use` field."
+  description = "A list of node pool names on which to run the job. Can be populated via `use` feild."
   type        = list(string)
@@ -53,3 +53,3 @@
 variable "node_pool_name" {
-  description = "A list of node pool names on which to run the job. Can be populated via `use` feild."
+  description = "A list of node pool names on which to run the job. Can be populated via `use` field."
   type        = list(string)
diff -U1 b/community/modules/file-system/nfs-server/README.md b/community/modules/file-system/nfs-server/README.md
--- b/community/modules/file-system/nfs-server/README.md
+++ b/community/modules/file-system/nfs-server/README.md
@@ -120,3 +120,3 @@
 | <a name="input_auto_delete_disk"></a> [auto\_delete\_disk](#input\_auto\_delete\_disk) | Whether or not the nfs disk should be auto-deleted | `bool` | `false` | no |
-| <a name="input_deployment_name"></a> [deployment\_name](#input\_deployment\_name) | Name of the HPC deployment, used as name of the NFS instance if no name is specified. | `string` | n/a | yes |
+| <a name="input_deployment_name"></a> [deployment\_name](#input\_deployment\_name) | Name of the HPC deployment, used as name of the NFS instace if no name is specified. | `string` | n/a | yes |
 | <a name="input_disk_size"></a> [disk\_size](#input\_disk\_size) | Storage size gb | `number` | `"100"` | no |
@@ -125,3 +125,3 @@
 | <a name="input_auto_delete_disk"></a> [auto\_delete\_disk](#input\_auto\_delete\_disk) | Whether or not the nfs disk should be auto-deleted | `bool` | `false` | no |
-| <a name="input_deployment_name"></a> [deployment\_name](#input\_deployment\_name) | Name of the HPC deployment, used as name of the NFS instace if no name is specified. | `string` | n/a | yes |
+| <a name="input_deployment_name"></a> [deployment\_name](#input\_deployment\_name) | Name of the HPC deployment, used as name of the NFS instance if no name is specified. | `string` | n/a | yes |
 | <a name="input_disk_size"></a> [disk\_size](#input\_disk\_size) | Storage size gb | `number` | `"100"` | no |
--- b/community/modules/scripts/ramble-setup/main.tf
+++ a/community/modules/scripts/ramble-setup/main.tf
@@ -24,3 +24,3 @@
     if [ -f ${var.install_dir}/share/ramble/setup-env.sh ]; then
-          echo "** Ramble's python virtualenv (/usr/local/ramble-python) is activated. Call 'deactivate' to deactivate."
+          echo "** Ramble's python virtualenv (/usr/local/ramble-python) is actiavted. Call 'deactivate' to deactivate."
           . /usr/local/ramble-python/bin/activate
diff -U1 b/modules/README.md b/modules/README.md
--- b/modules/README.md
+++ b/modules/README.md
@@ -473,3 +473,3 @@
 `terraform output`. This can useful for displaying the IP of a login node or
-printing instructions on how to use a module, as we have in the
+priting instructions on how to use a module, as we have in the
 [monitoring dashboard module](monitoring/dashboard/README.md#Outputs).
@@ -489,3 +489,3 @@
 `terraform output`. This can useful for displaying the IP of a login node or
-priting instructions on how to use a module, as we have in the
+printing instructions on how to use a module, as we have in the
 [monitoring dashboard module](monitoring/dashboard/README.md#Outputs).
only in patch2:
--- a/cmd/root.go
+++ b/cmd/root.go
@@ -197,3 +197,3 @@
 	}
-	// Code bellow assumes that `args0` contains path to file, not a
+	// Code below assumes that `args0` contains path to file, not a
 	// executable name from PATH.
only in patch2:
--- a/tools/maintenance/maintenance.py
+++ b/tools/maintenance/maintenance.py
@@ -168,3 +168,3 @@
     parser.add_argument("-m", "--print_periodic_vms", action="store_true",
-                        help="Disply nodes that have periodic" \
+                        help="Display nodes that have periodic" \
                              " maintenance setup")

nick-stroud · 2023-11-27T19:55:20Z

/gcbrun

rohitramu · 2023-11-27T20:06:10Z

/gcbrun

rohitramu · 2023-11-27T21:41:28Z

@yarikoptic It looks like the codespell pre-commit is failing right now in the PR-validation check:

codespell................................................................Failed
- hook id: codespell
- exit code: 65

If you run the pre-commit locally, do you get the same error?

nick-stroud · 2023-11-27T23:45:35Z

It looks like the pre-commit does not respect the .codespellrc file.

For example here is a sample of the errors:

Step #2 - "pre-commit-run": community/front-end/ofe/requirements.txt:4: astroid ==> asteroid
Step #2 - "pre-commit-run": community/front-end/ofe/website/ghpcfe/static/js/bootstrap.bundle.js:2947: trough ==> through
Step #2 - "pre-commit-run": community/front-end/ofe/website/ghpcfe/static/js/bootstrap.bundle.js:3420: othwerise ==> otherwise

These are in .js and requirements.txt files.

I was able to reproduce this locally by running pre-commit run codespell -a.

@yarikoptic, reassigning to you. See if you can get these skipped files observed by the pre-commit. Un-assign when you are ready for re-review. Thanks!

=== Do not change lines below === { "chain": [], "cmd": "codespell -w -i 3 -C 2 ./community/front-end/ofe/script/service_account.sh ./community/front-end/ofe/website/ghpcfe/models.py ./community/front-end/ofe/website/ghpcfe/models.py ./community/modules/scripts/htcondor-install/files/autoscaler.py ./community/modules/scripts/ramble-setup/README.md ./docs/videos/healthcare-and-life-sciences/README.md ./examples/README.md ./tools/validate_configs/test_configs/README.md", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^

=== Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^

until codespell-project/codespell#3196 is addressed

yarikoptic · 2023-11-28T01:54:26Z

sorry about that.

ref for issue in codespell: "Interaction" with pre-commit: ideally should skip the skipped files. codespell-project/codespell#3196
rebased while discarding actual run of codespell -w, which I then redid, and then added "custom" skips to pre-commit config

rohitramu · 2023-11-28T02:00:43Z

/gcbrun

* Add rudimentary codespell config * Add pre-commit definition for codespell * ot -> it typo fix * Some more skips for codespell * [DATALAD RUNCMD] Do interactive fixing of some ambigous typos === Do not change lines below === { "chain": [], "cmd": "codespell -w -i 3 -C 2 ./community/front-end/ofe/script/service_account.sh ./community/front-end/ofe/website/ghpcfe/models.py ./community/front-end/ofe/website/ghpcfe/models.py ./community/modules/scripts/htcondor-install/files/autoscaler.py ./community/modules/scripts/ramble-setup/README.md ./docs/videos/healthcare-and-life-sciences/README.md ./examples/README.md ./tools/validate_configs/test_configs/README.md", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ * 1 more typo fixed manually * Skip (S)hortcuts, more words and files * [DATALAD RUNCMD] run codespell throughout fixing typo automagically === Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ * Duplicate ignore of requirements.txt and js in pre-commit config until codespell-project/codespell#3196 is addressed

nick-stroud self-assigned this Nov 21, 2023

nick-stroud self-requested a review November 21, 2023 21:30

nick-stroud requested changes Nov 22, 2023

View reviewed changes

Comment thread pkg/config/expression.go Outdated

Comment thread .github/workflows/codespell.yml Outdated

nick-stroud assigned yarikoptic and unassigned nick-stroud Nov 22, 2023

nick-stroud added the release-improvements Added to release notes under the "Improvements" heading. label Nov 22, 2023

yarikoptic force-pushed the enh-codespell branch from ef2e1d4 to 4709fb0 Compare November 24, 2023 19:53

yarikoptic removed their assignment Nov 24, 2023

yarikoptic requested a review from nick-stroud November 24, 2023 19:57

nick-stroud self-assigned this Nov 27, 2023

nick-stroud approved these changes Nov 27, 2023

View reviewed changes

nick-stroud enabled auto-merge November 27, 2023 20:05

nick-stroud disabled auto-merge November 27, 2023 20:05

nick-stroud assigned rohitramu Nov 27, 2023

nick-stroud removed their assignment Nov 27, 2023

nick-stroud assigned yarikoptic and unassigned rohitramu Nov 27, 2023

yarikoptic added 7 commits November 27, 2023 20:46

Add rudimentary codespell config

7af0b2c

Add pre-commit definition for codespell

051afba

ot -> it typo fix

690348e

Some more skips for codespell

71a7ec3

1 more typo fixed manually

61ab4e0

Skip (S)hortcuts, more words and files

ddca8fd

yarikoptic added 2 commits November 27, 2023 20:46

[DATALAD RUNCMD] run codespell throughout fixing typo automagically

5e82927

=== Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^

Duplicate ignore of requirements.txt and js in pre-commit config

79cde00

until codespell-project/codespell#3196 is addressed

yarikoptic force-pushed the enh-codespell branch from 4709fb0 to 79cde00 Compare November 28, 2023 01:53

rohitramu assigned rohitramu and unassigned yarikoptic Nov 28, 2023

rohitramu merged commit 4d9a39a into GoogleCloudPlatform:develop Nov 28, 2023

nick-stroud mentioned this pull request Jan 9, 2024

Release v1.27.0 #2101

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add codespell: workflow,#1888

Add codespell: workflow,#1888
rohitramu merged 9 commits into
GoogleCloudPlatform:developfrom
yarikoptic:enh-codespell

yarikoptic commented Oct 26, 2023

Uh oh!

nick-stroud left a comment

Uh oh!

Uh oh!

Uh oh!

nick-stroud commented Nov 22, 2023

Uh oh!

yarikoptic commented Nov 24, 2023

Uh oh!

nick-stroud commented Nov 27, 2023

Uh oh!

rohitramu commented Nov 27, 2023

Uh oh!

rohitramu commented Nov 27, 2023

Uh oh!

nick-stroud commented Nov 27, 2023

Uh oh!

yarikoptic commented Nov 28, 2023

Uh oh!

rohitramu commented Nov 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

yarikoptic commented Oct 26, 2023

Submission Checklist

Uh oh!

nick-stroud left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nick-stroud commented Nov 22, 2023

Uh oh!

yarikoptic commented Nov 24, 2023

Uh oh!

nick-stroud commented Nov 27, 2023

Uh oh!

rohitramu commented Nov 27, 2023

Uh oh!

rohitramu commented Nov 27, 2023

Uh oh!

nick-stroud commented Nov 27, 2023

Uh oh!

yarikoptic commented Nov 28, 2023

Uh oh!

rohitramu commented Nov 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants