fix: Ignore 422 response while creating commit statuses

Signed-off-by: Ragnar Paide <[email protected]>

Author: ragnarpa

.github/workflows/ci.yaml

@@ -27,7 +27,7 @@ jobs:
       - name: Run golangci-lint
         uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.55.2
+          version: v1.64.5
           args: --timeout 5m
   test:
     runs-on: ubuntu-latest

docs/services/github.md

@@ -84,6 +84,20 @@ template.app-deployed: |
       content: |
         Application {{.app.metadata.name}} is now running new version of deployments manifests.
         See more here: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true
+      commentTag: "continuous-delivery/{{.app.metadata.name}}"
+    checkRun:
+      name: "continuous-delivery/{{.app.metadata.name}}"
+      details_url: "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true"
+      status: completed
+      conclusion: success
+      started_at: "YYYY-MM-DDTHH:MM:SSZ"
+      completed_at: "YYYY-MM-DDTHH:MM:SSZ"
+      output:
+        title: "Deployment of {{.app.metadata.name}} on ArgoCD"
+        summary: "Application {{.app.metadata.name}} is now running new version of deployments manifests."
+        text: |
+          Application {{.app.metadata.name}} is now running new version of deployments manifests.
+          See more here: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}?operation=true
 ```
 
 **Notes**:
@@ -94,4 +108,9 @@ template.app-deployed: |
   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).
 - If `github.pullRequestComment.content` is set to 65536 characters or more, it will be truncated.
+- The `github.pullRequestComment.commentTag` parameter is used to identify the comment. If a comment with the specified tag is found, it will be updated (upserted). If no comment with the tag is found, a new comment will be created.
 - Reference is optional. When set, it will be used as the ref to deploy. If not set, the revision will be used as the ref to deploy.
+
+## Commit Statuses
+
+The [method for generating commit statuses](https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#create-a-commit-status) allows a maximum of 1000 attempts using the same commit SHA and context. Once this limit is reached, the API returns validation errors (HTTP 422). The notification engine ignores these errors and marks the notification attempts as completed.

docs/services/opsgenie.md

@@ -2,28 +2,34 @@
 
 To be able to send notifications with argocd-notifications you have to create an [API Integration](https://docs.opsgenie.com/docs/integrations-overview) inside your [Opsgenie Team](https://docs.opsgenie.com/docs/teams).
 
-1. Login to Opsgenie at https://app.opsgenie.com or https://app.eu.opsgenie.com (if you have an account in the european union)
-2. Make sure you already have a team, if not follow this guide https://docs.opsgenie.com/docs/teams
-3. Click "Teams" in the Menu on the left
-4. Select the team that you want to notify
-5. In the teams configuration menu select "Integrations"
-6. Click "Add Integration" in the top right corner
-7. Select "API" integration
-8. Give your integration a name, copy the "API key" and safe it somewhere for later
-9. Click "Edit" in the integration settings
-10. Make sure the checkbox for "Create and Update Access" is selected, disable the other checkboxes to remove unnecessary permissions
-11. Click "Save" at the bottom
-12. Click "Turn on integration" in the top right corner
-13. Check your browser for the correct server apiURL. If it is "app.opsgenie.com" then use the US/international api url `api.opsgenie.com` in the next step, otherwise use `api.eu.opsgenie.com` (European API). 
-14. You are finished with configuring Opsgenie. Now you need to configure argocd-notifications. Use the apiUrl, the team name and the apiKey to configure the Opsgenie integration in the `argocd-notifications-secret` secret.
-15. You can find the example `argocd-notifications-cm` configuration at the below.
+1. Login to Opsgenie at https://app.opsgenie.com or https://app.eu.opsgenie.com (if you have an account in the European Union).
+2. Make sure you already have a team; if not, follow this guide: https://docs.opsgenie.com/docs/teams.
+3. Click "Teams" in the Menu on the left.
+4. Select the team that you want to notify.
+5. In the team's configuration menu, select "Integrations".
+6. Click "Add Integration" in the top right corner.
+7. Select "API" integration.
+8. Give your integration a name, copy the "API key", and save it somewhere for later.
+9. Click "Edit" in the integration settings.
+10. Make sure the checkbox for "Create and Update Access" is selected; disable the other checkboxes to remove unnecessary permissions.
+11. Click "Save" at the bottom.
+12. Click "Turn on integration" in the top right corner.
+13. Check your browser for the correct server apiURL. If it is "app.opsgenie.com", then use the US/international API URL `api.opsgenie.com`; otherwise, use `api.eu.opsgenie.com` (European API).
+14. You are finished with configuring Opsgenie. Now you need to configure argocd-notifications. Use the apiUrl, the team name, and the apiKey to configure the Opsgenie integration in the `argocd-notifications-secret` secret.
+15. You can find the example `argocd-notifications-cm` configuration below.
 
 | **Option**    | **Required** | **Type** | **Description**                                                                                          | **Example**                      |
 | ------------- | ------------ | -------- | -------------------------------------------------------------------------------------------------------- | -------------------------------- |
-| `description` | True         | `string` | Description field of the alert that is generally used to provide a detailed information about the alert. | `Hello from Argo CD!`            |
-| `priority`    | False        | `string` | Priority level of the alert. Possible values are P1, P2, P3, P4 and P5. Default value is P3.             | `P1`                             |
+| `description` | True         | `string` | Description field of the alert that is generally used to provide detailed information about the alert.   | `Hello from Argo CD!`            |
+| `priority`    | False        | `string` | Priority level of the alert. Possible values are P1, P2, P3, P4, and P5. Default value is P3.            | `P1`                             |
 | `alias`       | False        | `string` | Client-defined identifier of the alert, that is also the key element of Alert De-Duplication.            | `Life is too short for no alias` |
-| `note`       | False        | `string` | Additional note that will be added while creating the alert.            | `Error from Argo CD!` |
+| `note`        | False        | `string` | Additional note that will be added while creating the alert.                                            | `Error from Argo CD!`           |
+| `actions`     | False        | `[]string` | Custom actions that will be available for the alert.                                                    | `["Resolve", "Escalate"]`       |
+| `tags`        | False        | `[]string` | Tags of the alert.                                                                                        | `["critical", "deployment"]`    |
+| `visibleTo`   | False        | `[]alert.Responder` | Teams and users that the alert will become visible to without sending any notification. The `type` field is mandatory for each item, where possible values are `team` and `user`. In addition to the `type` field, either `id` or `name` should be provided for teams, and either `id` or `username` should be given for users. Please note that alerts will be visible to the teams specified within the `responders` field by default, so there is no need to re-specify them in the `visibleTo` field. | `[{Type: "team", Id: "team_id"}, {Type: "user", Id: "user_id"}]` |
+| `details`     | False        | `map[string]string` | Map of key-value pairs to use as custom properties of the alert.                                         | `{"environment": "production", "service": "web"}` |
+| `entity`      | False        | `string` | Entity field of the alert that is generally used to specify which domain the alert is related to.       | `web-server`                     |
+| `user`        | False        | `string` | Display name of the request owner.                                                                        | `admin_user`                     |
 
 ```yaml
 apiVersion: v1
@@ -47,18 +53,38 @@ data:
       priority: P1
       alias: {{.app.metadata.name}}
       note: Error from Argo CD!
+      actions:
+        - Restart
+        - AnExampleAction
+      tags:
+        - OverwriteQuietHours
+        - Critical
+      visibleTo:
+        - Id: "{{.app.metadata.responderId}}"
+          Type: "team"
+        - Name: "rocket_team"
+          Type: "team"
+        - Id: "{{.app.metadata.responderUserId}}"
+          Type: "user"
+        - Username: "[email protected]"
+          Type: "user"
+      details:
+        environment: production
+        service: web
+      entity: Argo CD Application
+      user: John Doe
   trigger.on-a-problem: |
     - description: Application has a problem.
       send:
       - opsgenie
       when: app.status.health.status == 'Degraded' or app.status.operationState.phase in ['Error', 'Failed'] or app.status.sync.status == 'Unknown'
 ```
 
-16. Add annotation in application yaml file to enable notifications for specific Argo CD app.
+16. Add annotation in the application YAML file to enable notifications for a specific Argo CD app.
 ```yaml
-  apiVersion: argoproj.io/v1alpha1
-  kind: Application
-  metadata:
-    annotations:
-      notifications.argoproj.io/subscribe.on-a-problem.opsgenie: <your-team>
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+  annotations:
+    notifications.argoproj.io/subscribe.on-a-problem.opsgenie: <your-team>
 ```

docs/services/rocketchat.md

@@ -4,7 +4,7 @@
 
 The Rocket.Chat notification service configuration includes following settings:
 
-* `email` - the Rocker.Chat user's email
+* `email` - the Rocker.Chat user's SAMAccountName
 * `password` - the Rocker.Chat user's password
 * `alias` - optional alias that should be used to post message
 * `icon` - optional message icon
@@ -25,7 +25,7 @@ The Rocket.Chat notification service configuration includes following settings:
 4. Copy username and password that you was created for bot user
 5. Create a public or private channel, or a team, for this example `my_channel`
 6. Add your bot to this channel **otherwise it won't work**
-7. Store email and password in argocd_notifications-secret Secret
+7. Store email and password in argocd-notifications-secret Secret
 
 ```yaml
 apiVersion: v1

docs/services/slack.md

@@ -21,11 +21,11 @@ The Slack notification service configuration includes following settings:
 
 1. Create Slack Application using https://api.slack.com/apps?new_app=1
 ![1](https://user-images.githubusercontent.com/426437/73604308-4cb0c500-4543-11ea-9092-6ca6bae21cbb.png)
-1. Once application is created navigate to `Enter OAuth & Permissions`
+1. Once application is created navigate to `OAuth & Permissions`
 ![2](https://user-images.githubusercontent.com/426437/73604309-4d495b80-4543-11ea-9908-4dea403d3399.png)
-1. Click `Permissions` under `Add features and functionality` section and add `chat:write` scope. To use the optional username and icon overrides in the Slack notification service also add the `chat:write.customize` scope.
+1. Go to `Scopes` > `Bot Token Scopes` > `Add an OAuth Scope`. Add `chat:write` scope. To use the optional username and icon overrides in the Slack notification service also add the `chat:write.customize` scope.
 ![3](https://user-images.githubusercontent.com/426437/73604310-4d495b80-4543-11ea-8576-09cd91aea0e5.png)
-1. Scroll back to the top, click 'Install App to Workspace' button and confirm the installation.
+1. `OAuth & Permission` > `OAuth Tokens for Your Workspace` > `Install to Workspace`
 ![4](https://user-images.githubusercontent.com/426437/73604311-4d495b80-4543-11ea-9155-9d216b20ec86.png)
 1. Once installation is completed copy the OAuth token.
 ![5](https://user-images.githubusercontent.com/426437/73604312-4d495b80-4543-11ea-832b-a9d9d5e4bc29.png)
@@ -117,6 +117,35 @@ template.app-sync-status: |
       }]
 ```
 
+If you want to specify an icon and username for each message, you can specify values for `username` and `icon` in the `slack` field.
+For icon you can specify emoji and image URL, just like in the service definition.
+If you set `username` and `icon` in template, the values set in template will be used even if values are specified in the service definition.
+
+```yaml
+template.app-sync-status: |
+  message: |
+    Application {{.app.metadata.name}} sync is {{.app.status.sync.status}}.
+    Application details: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}.
+  slack:
+    username: "testbot"
+    icon: https://example.com/image.png
+    attachments: |
+      [{
+        "title": "{{.app.metadata.name}}",
+        "title_link": "{{.context.argocdUrl}}/applications/{{.app.metadata.name}}",
+        "color": "#18be52",
+        "fields": [{
+          "title": "Sync Status",
+          "value": "{{.app.status.sync.status}}",
+          "short": true
+        }, {
+          "title": "Repository",
+          "value": "{{.app.spec.source.repoURL}}",
+          "short": true
+        }]
+      }]
+```
+
 The messages can be aggregated to the slack threads by grouping key which can be specified in a `groupingKey` string field under `slack` field.
 `groupingKey` is used across each template and works independently on each slack channel.
 When multiple applications will be updated at the same time or frequently, the messages in slack channel can be easily read by aggregating with git commit hash, application name, etc.

docs/triggers.md

@@ -15,8 +15,8 @@ data:
 ```
 
 * **trigger.\<name\>** - trigger name
-* **when** - a predicate expression that returns true or false. The expression evaluation is powered by [antonmedv/expr](https://github.com/antonmedv/expr).
-  The condition language syntax is described at [Language-Definition.md](https://github.com/antonmedv/expr/blob/master/docs/Language-Definition.md).
+* **when** - a predicate expression that returns true or false. The expression evaluation is powered by [expr-lang/expr](https://github.com/expr-lang/expr).
+  The condition language syntax is described at [Language-Definition.md](https://github.com/expr-lang/expr/blob/master/docs/Language-Definition.md).
 * **send** - the templates list that should be used to generate a notification.
 
 ### oncePer