Spelling (#220)

jsoref · pasha-codefresh · web-flow · commit f189f7e79a1d · 2023-10-18T13:01:12.000+03:00
* spelling: available

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: configuration

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: emoji

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: environment

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: github

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: notification

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: overridden

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: successfully

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: unmarshal

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: variable or

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: variables are

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

* spelling: webhook

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;

---------

Signed-off-by: Josh Soref &lt;jsoref@gmail.com&gt;
Co-authored-by: pasha-codefresh &lt;pavel@codefresh.io&gt;
diff --git a/docs/services/awssqs.md b/docs/services/awssqs.md
@@ -4,10 +4,10 @@
 
 This notification service is capable of sending simple messages to AWS SQS queue. 
 
-* `queue` - name of the queue you are intending to send messages to. Can be overwriten with target destination annotation.
+* `queue` - name of the queue you are intending to send messages to. Can be overridden with target destination annotation.
 * `region` - region of the sqs queue can be provided via env variable AWS_DEFAULT_REGION
 * `key` - optional, aws access key must be either referenced from a secret via variable or via env variable AWS_ACCESS_KEY_ID
-* `secret` - optional, aws access secret must be either referenced from a secret via variableor via env variable AWS_SECRET_ACCESS_KEY
+* `secret` - optional, aws access secret must be either referenced from a secret via variable or via env variable AWS_SECRET_ACCESS_KEY
 * `account` optional, external accountId of the queue
 * `endpointUrl` optional, useful for development with localstack
 
@@ -63,7 +63,7 @@ stringData:
 
 ### Minimal configuration using AWS Env variables
 
-Ensure following list of enviromental variable is injected via OIDC, or other method. And assuming SQS is local to the account.
+Ensure following list of environment variables are injected via OIDC, or other method. And assuming SQS is local to the account.
 You may skip usage of secret for sensitive data and omit other parameters. (Setting parameters via ConfigMap takes precedent.)
 
 Variables:
diff --git a/docs/services/github.md b/docs/services/github.md
@@ -87,5 +87,5 @@ template.app-deployed: |
 - If `github.repoURLPath` and `github.revisionPath` are same as above, they can be omitted.
 - Automerge is optional and `true` by default for github deployments to ensure the requested ref is up to date with the default branch.
   Setting this option to `false` is required if you would like to deploy older refs in your default branch.
-  For more information see the [Github Deployment API Docs](https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#create-a-deployment).
+  For more information see the [GitHub Deployment API Docs](https://docs.github.com/en/rest/deployments/deployments?apiVersion=2022-11-28#create-a-deployment).
 - If `github.pullRequestComment.content` is set to 65536 characters or more, it will be truncated.
diff --git a/docs/services/googlechat.md b/docs/services/googlechat.md
@@ -89,7 +89,7 @@ It is possible send both simple text and card messages in a chat thread by speci
 
 ```yaml
 template.app-sync-succeeded: |
-  message: The app {{ .app.metadata.name }} has succesfully synced!
+  message: The app {{ .app.metadata.name }} has successfully synced!
   googlechat:
     threadKey: {{ .app.metadata.name }}
 ```
diff --git a/docs/services/teams.md b/docs/services/teams.md
@@ -113,7 +113,7 @@ template.app-sync-succeeded: |
 
 ### summary field
 
-You can set a summary of the message that will be shown on Notifcation & Activity Feed 
+You can set a summary of the message that will be shown on Notification & Activity Feed 
 
 ![](https://user-images.githubusercontent.com/6957724/116587921-84c4d480-a94d-11eb-9da4-f365151a12e7.jpg)
 
diff --git a/docs/services/webhook.md b/docs/services/webhook.md
@@ -1,15 +1,15 @@
 # Webhook
 
 The webhook notification service allows sending a generic HTTP request using the templatized request body and URL.
-Using Webhook you might trigger a Jenkins job, update Github commit status.
+Using Webhook you might trigger a Jenkins job, update GitHub commit status.
 
 ## Parameters
 
 The Webhook notification service configuration includes following settings:
 
 - `url` - the url to send the webhook to
 - `headers` - optional, the headers to pass along with the webhook
-- `basicAuth` - optional, the basic authentication to pass along with the webook
+- `basicAuth` - optional, the basic authentication to pass along with the webhook
 - `insecureSkipVerify` - optional bool, true or false
 
 ## Configuration
@@ -67,7 +67,7 @@ metadata:
 
 ## Examples
 
-### Set Github commit status
+### Set GitHub commit status
 
 ```yaml
 apiVersion: v1
diff --git a/examples/certmanager/README.md b/examples/certmanager/README.md
@@ -143,7 +143,7 @@ func main() {
 
 The full source code is available in [cli/main.go](./cli/main.go). Use the following command:
 
-* to list avilable templates:
+* to list available templates:
 
 ```
 go run examples/certmanager/cli/main.go template get --config-map ./examples/certmanager/config.yaml --secret :empty
diff --git a/pkg/services/pagerduty.go b/pkg/services/pagerduty.go
@@ -100,6 +100,6 @@ func (p pagerdutyService) Send(notification Notification, dest Destination) erro
 		log.Errorf("Error: %v", err)
 		return err
 	}
-	log.Debugf("Incident created Succesfully. Incident Number: %v, IncidentKey:%v, incident.ID: %v, incident.Title: %v", incident.IncidentNumber, incident.IncidentKey, incident.ID, incident.Title)
+	log.Debugf("Incident created Successfully. Incident Number: %v, IncidentKey:%v, incident.ID: %v, incident.Title: %v", incident.IncidentNumber, incident.IncidentKey, incident.ID, incident.Title)
 	return nil
 }
diff --git a/pkg/services/pagerdutyv2.go b/pkg/services/pagerdutyv2.go
@@ -129,7 +129,7 @@ func (p pagerdutyV2Service) Send(notification Notification, dest Destination) er
 		log.Errorf("Error: %v", err)
 		return err
 	}
-	log.Debugf("PagerDuty event triggered succesfully. Status: %v, Message: %v", response.Status, response.Message)
+	log.Debugf("PagerDuty event triggered successfully. Status: %v, Message: %v", response.Status, response.Message)
 	return nil
 }
 
diff --git a/pkg/services/rocketchat.go b/pkg/services/rocketchat.go
@@ -82,7 +82,7 @@ func (r *rocketChatService) Send(notification Notification, dest Destination) er
 		if validEmoji.MatchString(r.opts.Icon) {
 			message.Emoji = r.opts.Icon
 		} else {
-			log.Warnf("Icon reference '%v' is not a valid emoij", r.opts.Icon)
+			log.Warnf("Icon reference '%v' is not a valid emoji", r.opts.Icon)
 		}
 	}
 	if r.opts.Avatar != "" {
diff --git a/pkg/services/slack.go b/pkg/services/slack.go
@@ -104,7 +104,7 @@ func buildMessageOptions(notification Notification, dest Destination, opts Slack
 		} else if isValidIconURL(opts.Icon) {
 			msgOptions = append(msgOptions, slack.MsgOptionIconURL(opts.Icon))
 		} else {
-			log.Warnf("Icon reference '%v' is not a valid emoij or url", opts.Icon)
+			log.Warnf("Icon reference '%v' is not a valid emoji or url", opts.Icon)
 		}
 	}
 	if notification.Slack != nil {
diff --git a/pkg/services/slack_test.go b/pkg/services/slack_test.go
@@ -9,7 +9,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestValidIconEmoij(t *testing.T) {
+func TestValidIconEmoji(t *testing.T) {
 	assert.Equal(t, true, validIconEmoji.MatchString(":slack:"))
 	assert.Equal(t, true, validIconEmoji.MatchString(":chart_with_upwards_trend:"))
 	assert.Equal(t, false, validIconEmoji.MatchString("http://lorempixel.com/48/48"))
diff --git a/pkg/subscriptions/annotations.go b/pkg/subscriptions/annotations.go
@@ -93,7 +93,7 @@ func (a Annotations) iterate(callback func(trigger string, service string, recip
 			}
 			err := yaml.Unmarshal(source, &subscriptions)
 			if err != nil {
-				log.Errorf("Notification subscription unrmashal error: %v", err)
+				log.Errorf("Notification subscription unmarshal error: %v", err)
 				callback("", "", recipients, k)
 			}
 			for _, v := range subscriptions {
diff --git a/pkg/triggers/service.go b/pkg/triggers/service.go
@@ -83,7 +83,7 @@ func (svc *service) Run(triggerName string, vars map[string]interface{}) ([]Cond
 		}
 
 		if prog, ok := svc.compiledConditions[condition.When]; !ok {
-			return nil, fmt.Errorf("trigger configiration has changed after initialization")
+			return nil, fmt.Errorf("trigger configuration has changed after initialization")
 		} else if val, err := expr.Run(prog, vars); err == nil {
 			boolRes, ok := val.(bool)
 			conditionResult.Triggered = ok && boolRes

Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,6 @@ func (p pagerdutyService) Send(notification Notification, dest Destination) erro`
`100`	`100`	`log.Errorf("Error: %v", err)`
`101`	`101`	`return err`
`102`	`102`	`}`
`103`		`- log.Debugf("Incident created Succesfully. Incident Number: %v, IncidentKey:%v, incident.ID: %v, incident.Title: %v", incident.IncidentNumber, incident.IncidentKey, incident.ID, incident.Title)`
	`103`	`+ log.Debugf("Incident created Successfully. Incident Number: %v, IncidentKey:%v, incident.ID: %v, incident.Title: %v", incident.IncidentNumber, incident.IncidentKey, incident.ID, incident.Title)`
`104`	`104`	`return nil`
`105`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ func (p pagerdutyV2Service) Send(notification Notification, dest Destination) er`
`129`	`129`	`log.Errorf("Error: %v", err)`
`130`	`130`	`return err`
`131`	`131`	`}`
`132`		`- log.Debugf("PagerDuty event triggered succesfully. Status: %v, Message: %v", response.Status, response.Message)`
	`132`	`+ log.Debugf("PagerDuty event triggered successfully. Status: %v, Message: %v", response.Status, response.Message)`
`133`	`133`	`return nil`
`134`	`134`	`}`
`135`	`135`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ func (r *rocketChatService) Send(notification Notification, dest Destination) er`
`82`	`82`	`if validEmoji.MatchString(r.opts.Icon) {`
`83`	`83`	`message.Emoji = r.opts.Icon`
`84`	`84`	`} else {`
`85`		`- log.Warnf("Icon reference '%v' is not a valid emoij", r.opts.Icon)`
	`85`	`+ log.Warnf("Icon reference '%v' is not a valid emoji", r.opts.Icon)`
`86`	`86`	`}`
`87`	`87`	`}`
`88`	`88`	`if r.opts.Avatar != "" {`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ func buildMessageOptions(notification Notification, dest Destination, opts Slack`
`104`	`104`	`} else if isValidIconURL(opts.Icon) {`
`105`	`105`	`msgOptions = append(msgOptions, slack.MsgOptionIconURL(opts.Icon))`
`106`	`106`	`} else {`
`107`		`- log.Warnf("Icon reference '%v' is not a valid emoij or url", opts.Icon)`
	`107`	`+ log.Warnf("Icon reference '%v' is not a valid emoji or url", opts.Icon)`
`108`	`108`	`}`
`109`	`109`	`}`
`110`	`110`	`if notification.Slack != nil {`