This is a GitHub Action that will publish a JSON message to an AWS SNS Topic. By default, this action will return the entire GitHub context as the MESSAGE for the AWS SNS topic. To send more specific data, update the MESSAGE environment variable that is passed in your .github/workflows/publish-to-sns.yaml.

The following inputs are required for this GitHub Action to successfully execute. These inputs should be entered in your GitHub repository settings (Secrets > Secrets and variables > Actions > Secrets tab):

This example shows you a typical use case configuration of .github/workflows/publish-to-sns.yaml where the action will execute when a pull request is opened:

name: Publish to AWS SNS Topic

on:
  pull_request:
    types: [opened, reopened, edited, ready_for_review]

env:
  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
  AWS_REGION: ${{ secrets.AWS_REGION }}
  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
  AWS_SNS_TOPIC_ARN: ${{ secrets.SNS_TOPIC_ARN }}
  MESSAGE: ${{ toJSON(github) }}

jobs:
  publish-to-sns:
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - name: Publish to AWS SNS Topic
        uses: d-dot-one/publish-to-sns@v1

This action publishes a message in the following format to AWS SNS:

{
  "message": "<JSON-formatted message>",
  "commit_id": "<GitHub Commit ID>"
}

You only need a single permission to be granted to the AWS IAM user that performs this action:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowSnSPublishForGitHubAction",
      "Action": [
        "sns:Publish"
      ],
      "Effect": "Allow",
      "Resource": "arn:aws:sns:us-east-1:111111111111:some-topic-name"
    }
  ]
}

You will find a terraform directory in this repository. It contains the infrastructure that you will need for this action to work in your environment. Consult the README.md there for more information.

This project is licensed under the MIT License.