Updated Pagerduty Self Service GitHub Actions

docs/create-self-service-experiences/setup-backend/github-workflow/examples/PagerDuty/acknowledge-incident.md

@@ -70,7 +70,7 @@ jobs:
               {
                 "incidents": [
                   {
-                    "id": "${{ fromJson(inputs.port_payload).port_context.entity }}",
+                    "id": "${{ fromJson(inputs.port_context).entity }}",
                     "type": "incident_reference",
                     "status": "acknowledged"
                   }
@@ -114,6 +114,7 @@ jobs:
               "created_at": "${{ fromJson(steps.acknowledge_incident.outputs.response).incidents[0].created_at }}",
               "updated_at": "${{ fromJson(steps.acknowledge_incident.outputs.response).incidents[0].updated_at }}"
             }
+          relations: "${{ toJson(fromJson(inputs.port_context).relations) }}"
           clientId: ${{ secrets.PORT_CLIENT_ID }}
           clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
           baseUrl: https://api.getport.io
@@ -191,8 +192,9 @@ Create a new self service action using the following JSON configuration.
       "{{if (.inputs | has(\"from\")) then \"from\" else null end}}": "{{.inputs.\"from\"}}",
       "port_context": {
         "blueprint": "{{.action.blueprint}}",
-        "entity": "{{.entity}}",
-        "run_id": "{{.run.id}}"
+        "entity": "{{.entity.identifier}}",
+        "run_id": "{{.run.id}}",
+        "relations": "{{.entity.relations}}"
       }
     },
     "reportWorkflowStatus": true

docs/create-self-service-experiences/setup-backend/github-workflow/examples/PagerDuty/change-on-call-user.md

@@ -173,6 +173,7 @@ jobs:
               "description": "${{ fromJson(steps.new_schedule.outputs.response).schedule.description}}",
               "users": ${{ env.user_summaries }}
             }
+          relations: "${{ toJson(fromJson(inputs.port_context).relations) }}"
           clientId: ${{ secrets.PORT_CLIENT_ID }}
           clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
           baseUrl: https://api.getport.io
@@ -250,16 +251,17 @@ Create a new self service action using the following JSON configuration.
     "type": "GITHUB",
     "org": "<GITHUB_ORG>",
     "repo": "<GITHUB_REPO>",
-    "workflow": "change-incident-owner.yaml",
+    "workflow": "change-on-call-user.yaml",
     "workflowInputs": {
       "{{if (.inputs | has(\"ref\")) then \"ref\" else null end}}": "{{.inputs.\"ref\"}}",
       "{{if (.inputs | has(\"start_time\")) then \"start_time\" else null end}}": "{{.inputs.\"start_time\"}}",
       "{{if (.inputs | has(\"end_time\")) then \"end_time\" else null end}}": "{{.inputs.\"end_time\"}}",
       "{{if (.inputs | has(\"new_on_call_user\")) then \"new_on_call_user\" else null end}}": "{{.inputs.\"new_on_call_user\"}}",
       "port_context": {
         "blueprint": "{{.action.blueprint}}",
-        "entity": "{{.entity}}",
-        "run_id": "{{.run.id}}"
+        "entity": "{{.entity.identifier}}",
+        "run_id": "{{.run.id}}",
+        "relations": "{{.entity.relations}}"
       }
     },
     "reportWorkflowStatus": true

docs/create-self-service-experiences/setup-backend/github-workflow/examples/PagerDuty/change-pagerduty-incident-owner.md

@@ -217,6 +217,7 @@ jobs:
               "created_at": "${{ fromJson(steps.change_owner.outputs.response).incident.created_at }}",
               "updated_at": "${{ fromJson(steps.change_owner.outputs.response).incident.updated_at }}"
             }
+          relations: "${{ toJson(fromJson(inputs.port_context).relations) }}"
           clientId: ${{ secrets.PORT_CLIENT_ID }}
           clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
           baseUrl: https://api.getport.io
@@ -290,12 +291,13 @@ Create a new self service action using the following JSON configuration.
     "workflow": "change-incident-owner.yaml",
     "workflowInputs": {
       "{{if (.inputs | has(\"ref\")) then \"ref\" else null end}}": "{{.inputs.\"ref\"}}",
-      "{{if (.inputs | has(\"new_owner_user_id\")) then \"new_owner_user_id\" else null end}}": "{{.inputs.\"new_owner_user_id\"}}",
+      "{{if (.inputs | has(\"new_owner\")) then \"new_owner\" else null end}}": "{{.inputs.\"new_owner\"}}",
       "{{if (.inputs | has(\"from\")) then \"from\" else null end}}": "{{.inputs.\"from\"}}",
       "port_context": {
         "blueprint": "{{.action.blueprint}}",
-        "entity": "{{.entity}}",
-        "run_id": "{{.run.id}}"
+        "entity": "{{.entity.identifier}}",
+        "run_id": "{{.run.id}}",
+        "relations": "{{.entity.relations}}"
       }
     },
     "reportWorkflowStatus": true

docs/create-self-service-experiences/setup-backend/github-workflow/examples/PagerDuty/create-pagerduty-service.md

@@ -69,11 +69,26 @@ jobs:
               "service": {
                 "name": "${{ github.event.inputs.name }}",
                 "description": "${{ github.event.inputs.description }}",
-                "escalation_policy": ${{ github.event.inputs.escalation_policy }}
+                "status": "active",
+                "escalation_policy": {
+                  "id": "${{ github.event.inputs.escalation_policy }}",
+                  "type": "escalation_policy_reference"
+                  }
+                }
               }
-            } 
-
-      - name: Create a log message
+
+      - name: Log Create Service Request Failure 
+        if: failure()
+        uses: port-labs/port-github-action@v1
+        with:
+          clientId: ${{ secrets.PORT_CLIENT_ID }}
+          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
+          baseUrl: https://api.getport.io
+          operation: PATCH_RUN
+          runId: ${{fromJson(inputs.port_context).run_id}}
+          logMessage: "Request to create service failed ..."
+
+      - name: Log Request Success
         uses: port-labs/port-github-action@v1
         with:
           clientId: ${{ secrets.PORT_CLIENT_ID }}
@@ -83,17 +98,37 @@ jobs:
           runId: ${{fromJson(inputs.port_context).run_id}}
           logMessage: |
              PagerDuty service created! ✅
-             Requesting for oncalls
+             Requesting for on-calls
 
-      - name: Request for oncalls for escalation_policy
+      - name: Request for oncalls for Escalation Policy
         id: fetch_oncalls
         uses: fjogeleit/http-request-action@v1
         with:
-          url: 'https://api.pagerduty.com/oncalls?include[]=users&escalation_policy_ids[]=${{ fromJson(github.event.inputs.escalation_policy).id }}'
+          url: 'https://api.pagerduty.com/oncalls?include[]=users&escalation_policy_ids[]=${{ inputs.escalation_policy }}'
           method: 'GET'
           customHeaders: '{"Content-Type": "application/json", "Accept": "application/json", "Authorization": "Token token=${{ secrets.PAGERDUTY_API_KEY }}"}'
 
-      - name: Create a log message
+      - name: Extract User Emails
+        if: steps.fetch_oncalls.outcome == 'success'
+        id: extract_user_emails
+        run: |
+          echo "Extracting user emails..."
+          EMAILS=$(echo '${{ steps.fetch_oncalls.outputs.response }}' | jq -c '[.oncalls[].user.email]')
+          echo "Extracted emails: $EMAILS"
+          echo "user_emails=${EMAILS}" >> $GITHUB_ENV
+
+      - name: Log Fetch Oncalls Request Failure
+        if: steps.fetch_oncalls.outcome == 'failure'
+        uses: port-labs/port-github-action@v1
+        with:
+          clientId: ${{ secrets.PORT_CLIENT_ID }}
+          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
+          baseUrl: https://api.getport.io
+          operation: PATCH_RUN
+          runId: ${{fromJson(inputs.port_context).run_id}}
+          logMessage: Failed to fetch on-calls ❌
+
+      - name: Log Before Upserting Entity
         uses: port-labs/port-github-action@v1
         with:
           clientId: ${{ secrets.PORT_CLIENT_ID }}
@@ -108,24 +143,23 @@ jobs:
         uses: port-labs/port-github-action@v1
         with:
           identifier: "${{ fromJson(steps.create_service_request.outputs.response).service.id }}" 
-          title: "${{ fromJson(steps.create_service_request.outputs.response).service.summary }}" 
-          team: "[]"
+          title: "${{ fromJson(steps.create_service_request.outputs.response).service.summary }}"
           icon: pagerduty
-          blueprint: ${{fromJson(inputs.port_context).blueprint}}
+          blueprint: "${{fromJson(inputs.port_context).blueprint}}"
           properties: |-
             {
               "status": "${{ fromJson(steps.create_service_request.outputs.response).service.status }}",
               "url": "${{ fromJson(steps.create_service_request.outputs.response).service.html_url }}",
-              "oncall": "${{ fromJson(steps.fetch_oncalls).oncalls }}"
+              "oncall": ${{ env.user_emails }}
             }
-          relations: "{}"
+          relations: "${{ toJson(fromJson(inputs.port_context).relations) }}"
           clientId: ${{ secrets.PORT_CLIENT_ID }}
           clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
           baseUrl: https://api.getport.io
           operation: UPSERT
           runId: ${{fromJson(inputs.port_context).run_id}}
 
-      - name: Create a log message
+      - name: Log After Upserting Entity
         uses: port-labs/port-github-action@v1
         with:
           clientId: ${{ secrets.PORT_CLIENT_ID }}
@@ -134,7 +168,7 @@ jobs:
           operation: PATCH_RUN
           runId: ${{fromJson(inputs.port_context).run_id}}
           logMessage: |
-              Upsert was successful ✅
+              Upserting was successful ✅
 ```
 </details>
 
@@ -175,7 +209,7 @@ Create a new self service action using the following JSON configuration.
           "description": "PagerDuty Escalation Policy ID to apply",
           "icon": "pagerduty",
           "type": "string"
-        },
+        }
       },
       "required": [
         "name",
@@ -201,8 +235,9 @@ Create a new self service action using the following JSON configuration.
       "{{if (.inputs | has(\"escalation_policy\")) then \"escalation_policy\" else null end}}": "{{.inputs.\"escalation_policy\"}}",
       "port_context": {
         "blueprint": "{{.action.blueprint}}",
-        "entity": "{{.entity}}",
-        "run_id": "{{.run.id}}"
+        "entity": "{{.entity.identifier}}",
+        "run_id": "{{.run.id}}",
+        "relations": "{{.entity.relations}}"
       }
     },
     "reportWorkflowStatus": true

docs/create-self-service-experiences/setup-backend/github-workflow/examples/PagerDuty/escalate-an-incident.md

@@ -72,7 +72,7 @@ jobs:
         id: escalate_incident
         uses: fjogeleit/http-request-action@v1
         with:
-          url: 'https://api.pagerduty.com/incidents/${{inputs.entity_identifier}}'
+          url: 'https://api.pagerduty.com/incidents/${{fromJson(inputs.port_context).entity}}'
           method: 'PUT'
           customHeaders: '{"Content-Type": "application/json", "Accept": "application/vnd.pagerduty+json;version=2", "Authorization": "Token token=${{ secrets.PAGERDUTY_API_KEY }}", "From": "${{ github.event.inputs.from }}"}'
           data: >-
@@ -109,6 +109,7 @@ jobs:
           logMessage: "Reporting the escalated incident back to Port ..."
 
       - name: Upsert pagerduty entity to Port 
+        id: upsert_entity
         uses: port-labs/port-github-action@v1
         with:
           identifier: ${{inputs.entity_identifier}}
@@ -124,14 +125,15 @@ jobs:
               "created_at": "${{ fromJson(steps.escalate_incident.outputs.response).incident.created_at }}",
               "updated_at": "${{ fromJson(steps.escalate_incident.outputs.response).incident.updated_at }}"
             }
+          relations: "${{ toJson(fromJson(inputs.port_context).relations) }}"
           clientId: ${{ secrets.PORT_CLIENT_ID }}
           clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
           baseUrl: https://api.getport.io
           operation: UPSERT
           runId: ${{fromJson(inputs.port_context).run_id}}
 
       - name: Inform Entity upsert failure
-        if: failure()
+        if: steps.upsert_entity.outcome == 'failure'
         uses: port-labs/port-github-action@v1
         with:
           clientId: ${{ secrets.PORT_CLIENT_ID }}
@@ -141,7 +143,7 @@ jobs:
           runId: ${{fromJson(inputs.port_context).run_id}}
           logMessage: "Failed to report the escalated incident back to Port ..."
 
-      - name: Inform completion of PagerDuty escalation process into Port
+      - name: Inform completion of PagerDuty incident escalation
         uses: port-labs/port-github-action@v1
         with:
           clientId: ${{ secrets.PORT_CLIENT_ID }}
@@ -227,8 +229,9 @@ Create a new self service action using the following JSON configuration.
       "{{if (.inputs | has(\"from\")) then \"from\" else null end}}": "{{.inputs.\"from\"}}",
       "port_context": {
         "blueprint": "{{.action.blueprint}}",
-        "entity": "{{.entity}}",
-        "run_id": "{{.run.id}}"
+        "entity": "{{.entity.identifier}}",
+        "run_id": "{{.run.id}}",
+        "relations": "{{.entity.relations}}"
       }
     },
     "reportWorkflowStatus": true

docs/create-self-service-experiences/setup-backend/github-workflow/examples/PagerDuty/resolve-incident.md

@@ -71,7 +71,7 @@ jobs:
               {
                 "incidents": [
                   {
-                    "id": "${{ fromJson(inputs.port_payload).port_context.entity }}",
+                    "id": "${{fromJson(inputs.port_context).entity}}",
                     "type": "incident_reference",
                     "status": "resolved"
                   }
@@ -114,6 +114,7 @@ jobs:
               "created_at": "${{ fromJson(steps.resolve_incident.outputs.response).incidents[0].created_at }}",
               "updated_at": "${{ fromJson(steps.resolve_incident.outputs.response).incidents[0].updated_at }}"
             }
+          relations: "${{ toJson(fromJson(inputs.port_context).relations) }}"
           clientId: ${{ secrets.PORT_CLIENT_ID }}
           clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
           baseUrl: https://api.getport.io
@@ -169,16 +170,17 @@ Create a new self service action using the following JSON configuration.
   },
   "invocationMethod": {
     "type": "GITHUB",
-    "org": "<GITHUB_ORG>",
-    "repo": "<GITHUB_REPO>",
+    "org": "GITHUB_ORG",
+    "repo": "GITHUB_REPO",
     "workflow": "resolve-incident.yaml",
     "workflowInputs": {
       "{{if (.inputs | has(\"ref\")) then \"ref\" else null end}}": "{{.inputs.\"ref\"}}",
       "{{if (.inputs | has(\"from\")) then \"from\" else null end}}": "{{.inputs.\"from\"}}",
       "port_context": {
         "blueprint": "{{.action.blueprint}}",
-        "entity": "{{.entity}}",
-        "run_id": "{{.run.id}}"
+        "entity": "{{.entity.identifier}}",
+        "run_id": "{{.run.id}}",
+        "relations": "{{.entity.relations}}"
       }
     },
     "reportWorkflowStatus": true