Skip to main content

Slack reminders for scorecards

This guide takes 7 minutes to complete, and aims to demonstrate:

  • How to initiate changes in the organization using scorecards
  • How to automate Slack reminders using Port's self service actions
Prerequisites
  • This guide assumes you have a Port account and that you have finished the onboarding process. We will use the Service blueprint that was created during the onboarding process.
  • You will need a Git repository in which you can place a workflow/pipeline that we will use in this guide. If you don't have one, we recommend creating a new repository named Port-actions.

The goal of this guide​

In this guide we will create a self-service action that sends a Slack reminder for uncompleted scorecard rules. In reality, such an action can be used by R&D managers / Platform engineers to remind developers of unmet standards.

After completing it, you will get a sense of how it can benefit different personas in your organization:

  • Developers will be notified about policies set by the platform engineer that need to be fixed.
  • R&D managers & Platform engineers will be able to remind developers about unmet requirements in the services.

Setup the action's frontend​

Onboarding

As part of the onboarding process, you should already have an action named Send scorecard reminder in your self-service tab.

If you skipped the onboarding, follow the instructions listed here.

  1. Head to the Self-service page of your portal. Hover over the Send scorecard reminder action, click the ... button in the top right corner, and choose "Edit":

  2. The action's basic details should look like the image below. This action has no user inputs, so when ready, click on the Backend tab to proceed.

Define backend type​

Now we'll define the backend type of the action. Port supports multiple invocation types, one of them should be selected for you depending on the Git provider you selected in the beginning of the onboarding process.

Fill out the form with your values:

  • Replace the Organization and Repository values with your values (this is where the workflow will reside and run).

  • Name the workflow port-slack-reminder.yml.

  • Fill out your workflow details:


  • Scroll down to the Configure the invocation payload section.
    This is where you can define which data will be sent to your backend each time the action is executed.

    For this action, our backend only needs to know the id of the action run, so let's send it.
    Copy the following JSON snippet and paste it in the payload code box:

    {
      "runId": "{{ .run.id }}"
    }

The last step is customizing the action's permissions. For simplicity's sake, we will use the default settings. For more information, see the permissions page. Click Save.

The action's frontend is now ready 🥳


Setup the action's backend​

Now we want to write the logic that our action will trigger:

First, let's create the necessary token and secrets:

  • Go to your desired Slack channel and setup incoming webhooks. Make sure you copy the webhook URL, we will use it in the Github workflow.

  • Go to your Port application, click on the ... in the top right corner, then click Credentials. Copy your Client ID and Client secret.

In the repository where your workflow will reside, create 3 new secrets under Settings -> Secrets and variables -> Actions:

  • SLACK_WEBHOOK_URL - the Slack Webhook URL of the destination channel.
  • PORT_CLIENT_ID - the client ID you copied from your Port app.
  • PORT_CLIENT_SECRET - the client secret you copied from your Port app.


Now let's create the workflow file that contains our logic. Under .github/workflows, create a new file named port-slack-reminder.yml and use the following snippet as its content:

Github workflow (click to expand)
# port-slack-reminder.yml

name: Generate Scorecards Reminders
on:
  workflow_dispatch:
    inputs:
      runId:
        description: 'The id of the action run'
        required: true
        type: string
jobs:
    generate-scorecards-reminders:
        runs-on: ubuntu-latest
        steps:
            - name: Generate Scorecards Reminders
              uses: port-labs/port-sender@v0.2.3
              with:
                operation_kind: scorecard_reminder
                port_client_id: ${{ secrets.PORT_CLIENT_ID }}
                port_client_secret: ${{ secrets.PORT_CLIENT_SECRET }}
                port_region: eu
                slack_webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}
                blueprint: service
                scorecard: ProductionReadiness
                target_kind: slack
            - name: Report status to Port
              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: ${{ inputs.runId }}
                logMessage: |
                    Slack reminder sent successfully 🚀
Port Initiatives sender Github action

This workflow uses Port's Initiatives Sender GitHub Action to send a Slack message.

Selecting a Port API URL by account region

The baseUrl, port_region, port.baseUrl, portBaseUrl, port_base_url and OCEAN__PORT__BASE_URL parameters are used to select which instance or Port API will be used.

Port exposes two API instances, one for the EU region of Port, and one for the US region of Port.

All done! The action is ready to be used 🚀

Execute the action​

After creating an action, it will appear under the Self-service tab of your Port application:

  1. Click on Create to begin executing the action.

  2. Click Execute. A small popup will appear, click on View details:



  1. This page provides details about the action run. As you can see, the backend returned Success and the repo was successfully created:
Logging action progress

💡 Note the Log stream at the bottom, this can be used to report progress, results and errors. Click here to learn more.


  1. You can now enter your Slack channel and view the scorecard reminder:

Congratulations! You can now send Slack reminders easily from Port 💪🏽

Conclusion​

Creating scorecards is the first step in setting standards in our development lifecycle. However, to ensure these standards are met, we need to turn rule violations into action items. By automating Slack reminders and the creation of Jira tasks, we can drive change across the entire organization using familiar tools to combine it natively within our delievery lifecycle.

More Examples​