Spelling #6747

jsoref · 2024-11-01T11:44:01Z

This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at https://github.com/jsoref/contour/actions/runs/11628797911#summary-32384590478

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/contour/actions/runs/11628798577#summary-32384592098

Signed-off-by: Josh Soref <[email protected]>

github-actions · 2024-11-01T11:44:51Z

Hi @jsoref! Welcome to our community and thank you for opening your first Pull Request. Someone will review it soon. Thank you for committing to making Contour better. You can also join us on our mailing list and in our channel in the Kubernetes Slack Workspace

jsoref

As noted in Slack, I'm a human, and I manually selected the corrections. That means I can make mistakes. I didn't spot any for this PR while composing this review, but that doesn't mean there aren't any (I did spot one yesterday for a similar PR that I made elsewhere -- I picked the wrong correction for schame).

I compose changes in a word-family/correction per commit which means if you object to a correction, I can easily drop it (e.g. into, or preexisting). Changes are generally done using tooling for some flavor of search-and-replace (although sometimes they're purely manual). I use VS Code and test w/ CI to try to ensure that I haven't broken tests (the tests here required tags which I didn't have initially, so I had to borrow a tag...). I try to ensure that I don't break whitespace (review shows that in at least one place I adjusted whitespace -- I'm not sure if that was me or VS Code, I think it was me being careful to ensure the replacement included a space).

It's possible for me to split by directory or file extension, but I generally try to discourage that, and while it's occasionally possible for me to split by "comment" vs "code", I wouldn't be able to do that for this repository this year.

jsoref · 2024-11-01T11:45:37Z

CONTRIBUTING.md

-#### MacOS
+#### macOS


jsoref · 2024-11-01T11:46:55Z

apis/projectcontour/v1/helpers.go

@@ -187,7 +187,7 @@ func getIndex(condType string, subconds []SubCondition) int {
 	return -1
 }

-// GetConditionFor returns the a pointer to the condition for a given type,
+// GetConditionFor returns a pointer to the condition for a given type,


It's hard to pick the proper article, but there can be only one...

jsoref · 2024-11-01T12:14:28Z

internal/envoy/v3/socket_test.go

@@ -27,11 +27,11 @@ import (

 func TestUpstreamTLSTransportSocket(t *testing.T) {
 	tests := map[string]struct {
-		ctxt *envoy_transport_socket_tls_v3.UpstreamTlsContext
+		ctx  *envoy_transport_socket_tls_v3.UpstreamTlsContext


there are many possible ways to abbreviate context, but this short form dominates this repository (and happens to be my preference)

jsoref · 2024-11-01T12:16:24Z

internal/featuretests/v3/secrets_test.go

@@ -171,7 +171,7 @@ func TestSDSShouldNotIncrementVersionNumberForUnrelatedSecret(t *testing.T) {

 // issue 1169, an invalid certificate should not be
 // presented by SDS even if referenced by an ingress object.
-func TestSDSshouldNotPublishInvalidSecret(t *testing.T) {
+func TestSDSShouldNotPublishInvalidSecret(t *testing.T) {


It's certainly fine to drop this, but a good tool/human will be able to properly parse this as:

Test SDS Should Not Publish Invalid Secret

Just as they should be able to properly parse HTTPProxy as HTTP Proxy (as long as it's properly spelled...) or TestUpstreamTLSWithHTTPRoute...

jsoref · 2024-11-01T12:17:03Z

internal/featuretests/v3/upstreamtls_test.go

@@ -462,7 +462,7 @@ func TestBackendTLSPolicyPrecedenceOverUpstreamProtocolAnnotationWithHTTPRoute(t

 // Test that a unique cluster name is generated when there is an HTTPProxy with upstream TLS settings
 // and an HTTPRoute with a BackendTLSPolicy, configured with unique TLS settings, targeting the same service.
-func TestUpstreamTLSWithHTTPRouteANDHTTPProxy(t *testing.T) {
+func TestUpstreamTLSWithHTTPRouteAndHTTPProxy(t *testing.T) {


Afaict, this was not an acronym...

jsoref · 2024-11-01T12:38:25Z

site/content/docs/main/config/api-reference.html

@@ -1917,7 +1917,7 @@ <h3 id="projectcontour.io/v1.HeaderMatchCondition">HeaderMatchCondition
 </td>
 <td>
 <p>Name is the name of the header to match against. Name is required.
-Header names are case insensitive.</p>
+Header names are case-insensitive.</p>


I should call out that I don't have the 1.31 doc fixes here because I branched before that. If you're doing a running review, hopefully you're telling github which changes you've seen so that I can add in the changes for 1.31 at some point. My preference is to amend things into the corresponding commits, but I'm happy to do w/ unsquashed "fixup" commits (and not force-push) if that helps reviewers...

The way I tend to do catch ups is to rebase the spell-check + spelling branches onto a fetched upstream and repeat the workflow until I get back to 0 errors (but I do it in a separate repository to avoid people seeing until I'm ready)...

jsoref · 2024-11-01T12:40:16Z

site/content/docs/main/config/request-routing.md

@@ -454,7 +454,7 @@ spec:
      strategy: RequestHash
      requestHashPolicies:
      - queryParameterHashOptions:
-          prameterName: param1
+          parameterName: param1


As noted earlier for a similar documentation item, this typo only appears in docs and there's nothing to indicate it's intentional.

jsoref · 2024-11-01T12:48:03Z

site/themes/contour/assets/scss/_footer.scss

@@ -31,7 +31,7 @@ footer {
        p {
            margin: 0px;
        }
-        .copywrite {
+        .copyright {


this is a style change -- the only consumer in this repository is also changed.
it's possible for someone to include this css file in an external consumer (as it's technically a public resource, and thus it's techncially an api change), but, they really shouldn't, ...

jsoref · 2024-11-01T12:48:16Z

site/themes/contour/layouts/partials/footer.html

@@ -11,7 +11,7 @@
 			</div>
 		</div>
 		<div class="bottom-links">
-			<div class="copywrite">
+			<div class="copyright">


this is the corresponding consumer

jsoref · 2024-11-01T12:50:06Z

test/scripts/get-contour-upgrade-from-version.sh

@@ -14,7 +14,7 @@ if CURRENT_TAG=$(git describe --tags --exact-match 2>/dev/null); then
  git tag -l --sort=-v:refname | grep -A5 -x $CURRENT_TAG | grep -v -x $CURRENT_TAG | grep -v 'alpha\|beta\|rc' | head -n 1
 elif git describe --tags --abbrev=0 | grep -q -v v1.2.0; then
  # Note: Contour v1.2.0 was improperly tagged on main so we
-  # ignore it to ensure we dont hit that case here.
+  # ignore it to ensure we don't hit that case here.


while this seems fairly innocuous, it's the kind of change that should be scrutinized the most.
thankfully, # will properly ignore 's and thus I believe it's harmless (but you shoukd never trust a random PR submitter).

sunjayBhatia

Rather than have this as a one-off, sounds like this is a suggestion to use the https://github.com/marketplace/actions/check-spelling action rather than codespell?

If you want to swap that action out or fix the codespell configuration to catch these errors we would be open to that change

codecov · 2024-11-08T21:32:42Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.04%. Comparing base (e5a25e2) to head (072495f).
Report is 59 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6747      +/-   ##
==========================================
- Coverage   81.76%   81.04%   -0.73%     
==========================================
  Files         133      133              
  Lines       15944    20001    +4057     
==========================================
+ Hits        13037    16210    +3173     
- Misses       2614     3498     +884     
  Partials      293      293

Files with missing lines	Coverage Δ
internal/annotation/annotations.go	`100.00% <ø> (ø)`
internal/contour/cond.go	`100.00% <ø> (ø)`
internal/dag/accessors.go	`87.55% <ø> (-0.15%)`	⬇️
internal/dag/gatewayapi_processor.go	`94.65% <ø> (+0.77%)`	⬆️
internal/dag/policy.go	`95.67% <ø> (+0.12%)`	⬆️
internal/envoy/v3/cluster.go	`96.47% <100.00%> (+0.06%)`	⬆️
internal/provisioner/controller/gatewayclass.go	`71.00% <100.00%> (-0.13%)`	⬇️
...nternal/provisioner/objects/dataplane/dataplane.go	`85.74% <100.00%> (-1.90%)`	⬇️
internal/provisioner/objects/object.go	`82.50% <ø> (-1.38%)`	⬇️
internal/sorter/sorter.go	`100.00% <100.00%> (ø)`
... and 3 more

... and 114 files with indirect coverage changes

github-actions · 2024-11-25T00:28:02Z

The Contour project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 14d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, the PR is closed

You can:

Ensure your PR is passing all CI checks. PRs that are fully green are more likely to be reviewed. If you are having trouble with CI checks, reach out to the #contour channel in the Kubernetes Slack workspace.
Mark this PR as fresh by commenting or pushing a commit
Close this PR
Offer to help out with triage

Please send feedback to the #contour channel in the Kubernetes Slack

jsoref · 2024-11-25T01:19:56Z

@sunjayBhatia: once this is merged, i'm more than happy to offer a PR for the workflow, but right now the bot is threatening to kill the PR...

github-actions · 2024-12-10T00:28:22Z

The Contour project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 14d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, the PR is closed

You can:

Ensure your PR is passing all CI checks. PRs that are fully green are more likely to be reviewed. If you are having trouble with CI checks, reach out to the #contour channel in the Kubernetes Slack workspace.
Mark this PR as fresh by commenting or pushing a commit
Close this PR
Offer to help out with triage

Please send feedback to the #contour channel in the Kubernetes Slack

jsoref added 30 commits October 14, 2024 21:58

spelling: a

ad479a3

Signed-off-by: Josh Soref <[email protected]>

spelling: across

5b229b5

Signed-off-by: Josh Soref <[email protected]>

spelling: add-or

a747431

Signed-off-by: Josh Soref <[email protected]>

spelling: add

2a20293

Signed-off-by: Josh Soref <[email protected]>

spelling: all

12ff557

Signed-off-by: Josh Soref <[email protected]>

spelling: alphabetical

b99bc7e

Signed-off-by: Josh Soref <[email protected]>

spelling: an external

3a7f861

Signed-off-by: Josh Soref <[email protected]>

spelling: and-http

aea4ddd

Signed-off-by: Josh Soref <[email protected]>

spelling: antithetical

8d1b793

Signed-off-by: Josh Soref <[email protected]>

spelling: api server

8d6015a

Signed-off-by: Josh Soref <[email protected]>

spelling: arg

6a927ab

Signed-off-by: Josh Soref <[email protected]>

spelling: authorization

af4909b

Signed-off-by: Josh Soref <[email protected]>

spelling: bureaucratic

6db5eea

Signed-off-by: Josh Soref <[email protected]>

spelling: case-insensitive

82c66bd

Signed-off-by: Josh Soref <[email protected]>

spelling: case-sensitive

8810f7c

Signed-off-by: Josh Soref <[email protected]>

spelling: certgen

3c20531

Signed-off-by: Josh Soref <[email protected]>

spelling: cherry-pick

5632322

Signed-off-by: Josh Soref <[email protected]>

spelling: circuitbreaker

891b526

Signed-off-by: Josh Soref <[email protected]>

spelling: cluster

bee3dfb

Signed-off-by: Josh Soref <[email protected]>

spelling: communicates

f82a5b2

Signed-off-by: Josh Soref <[email protected]>

spelling: condition

ec17e00

Signed-off-by: Josh Soref <[email protected]>

spelling: conflict

34153c3

Signed-off-by: Josh Soref <[email protected]>

spelling: connections

3a3ad34

Signed-off-by: Josh Soref <[email protected]>

spelling: consequence

5a2cfee

Signed-off-by: Josh Soref <[email protected]>

spelling: copyright

ab95b2f

Signed-off-by: Josh Soref <[email protected]>

spelling: ctx

ceb482b

Signed-off-by: Josh Soref <[email protected]>

spelling: daemonset

5eb58c8

Signed-off-by: Josh Soref <[email protected]>

spelling: delegation

8da3866

Signed-off-by: Josh Soref <[email protected]>

spelling: deployment

609ca67

Signed-off-by: Josh Soref <[email protected]>

spelling: distinguished

e35ea2a

Signed-off-by: Josh Soref <[email protected]>

jsoref added 12 commits October 31, 2024 18:17

spelling: separated

00893f5

Signed-off-by: Josh Soref <[email protected]>

spelling: shifting

3a09759

Signed-off-by: Josh Soref <[email protected]>

spelling: should

8d98a3b

Signed-off-by: Josh Soref <[email protected]>

spelling: shout-out

d5a387f

Signed-off-by: Josh Soref <[email protected]>

spelling: supported

bfc1eee

Signed-off-by: Josh Soref <[email protected]>

spelling: the

ae8e66f

Signed-off-by: Josh Soref <[email protected]>

spelling: timeout

a61f9f1

Signed-off-by: Josh Soref <[email protected]>

spelling: tls

2ea9353

Signed-off-by: Josh Soref <[email protected]>

spelling: transfer

620d5ae

Signed-off-by: Josh Soref <[email protected]>

spelling: transformation

1cb6e81

Signed-off-by: Josh Soref <[email protected]>

spelling: validation

dccaedc

Signed-off-by: Josh Soref <[email protected]>

spelling: with

072495f

Signed-off-by: Josh Soref <[email protected]>

jsoref requested a review from a team as a code owner November 1, 2024 11:44

jsoref requested review from tsaarni and sunjayBhatia and removed request for a team November 1, 2024 11:44

sunjayBhatia requested review from a team, rajatvig and izturn and removed request for a team November 1, 2024 11:44

jsoref commented Nov 1, 2024

View reviewed changes

sunjayBhatia reviewed Nov 8, 2024

View reviewed changes

github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 25, 2024

sunjayBhatia removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 25, 2024

github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spelling #6747

Spelling #6747

jsoref commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

jsoref left a comment

jsoref Nov 1, 2024

jsoref Nov 1, 2024

jsoref Nov 1, 2024

jsoref Nov 1, 2024

jsoref Nov 1, 2024

jsoref Nov 1, 2024

jsoref Nov 1, 2024

jsoref Nov 1, 2024

jsoref Nov 1, 2024

jsoref Nov 1, 2024

sunjayBhatia left a comment

codecov bot commented Nov 8, 2024 •

edited

Loading

github-actions bot commented Nov 25, 2024

jsoref commented Nov 25, 2024

github-actions bot commented Dec 10, 2024

		#### MacOS
		#### macOS

Spelling #6747

Are you sure you want to change the base?

Spelling #6747

Conversation

jsoref commented Nov 1, 2024

github-actions bot commented Nov 1, 2024

jsoref left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sunjayBhatia left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 8, 2024 • edited Loading

Codecov Report

github-actions bot commented Nov 25, 2024

jsoref commented Nov 25, 2024

github-actions bot commented Dec 10, 2024

codecov bot commented Nov 8, 2024 •

edited

Loading