README.md

AWS SNS - Publish Topic

Send a SNS Topic via GitHub Actions

Usage

1. Set up your credentials as secrets in your repository settings using AWS_REGION, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY

2. Add the following to your workflow

- name: Publish SNS Topic
  uses: nothingalike/[email protected]
  with:
    MESSAGE: "message"
    TOPIC_ARN: "arn:aws:sns:[your region]:[your account id]:[your topic name]"
  env:
    AWS_REGION: ${{ secrets.AWS_REGION }}
    AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
    AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

Inputs

MESSAGE

Required This is your serialized message

TOPIC_ARN

Required This is the ARN of the SNS Topic you are publishing

AWS_REGION

A AWS Region. Can alternatively be stored in environment

AWS_ACCESS_KEY_ID

A AWS Access Key ID. Can alternatively be stored in environment

AWS_SECRET_ACCESS_KEY

A AWS Secret Access Key. Can alternatively be stored in environment

Outputs

MessageId

The SID of the message resource associated with the Published Topic.

Contributing

Third Party Licenses

This GitHub Action uses a couple of Node.js modules to work.

License and other copyright information for each module are included in the release branch of each action version under node_modules/{module}.

More information for each package can be found at https://www.npmjs.com/package/{package}

License