Merge pull request #1 from newrelic/feat/deployment-marker-action

feat: application deployment marker action

Author: sanderblue

.dockerignore

@@ -0,0 +1,2 @@
+*.md
+.gitignore

.gitignore

@@ -0,0 +1 @@
+.DS_Store

Dockerfile

@@ -0,0 +1,8 @@
+FROM newrelic/cli:latest
+
+# Copies your code file from your action repository to the filesystem path `/` of the container
+# COPY entrypoint.sh /entrypoint.sh
+COPY entrypoint.sh /entrypoint.sh
+
+# Code file to execute when the docker container starts up (`entrypoint.sh`)
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -0,0 +1,37 @@
+# New Relic Application Deployment Marker
+New Relic App Deployment Marker
+
+[![GitHub Marketplace version](https://img.shields.io/github/release/newrelic/deployment-marker-action.svg?label=Marketplace&logo=github)](https://github.com/marketplace/actions/new-relic-application-deployment-marker)
+
+A GitHub Action to add New Relic deployment markers during your release pipeline.
+
+## Inputs
+
+| Key             |          | Description                                                                                                                              |
+| --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| `api_key`       | required | Your New Relic [personal API key](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#personal-api-key). |
+| `applicationId` | required | The New Relic application ID to apply the deployment marker.                                                                             |
+| `region`        | optional | The region of your New Relic account. Default: "US"                                                                                      |
+| `revision`      | optional | Metadata to apply to the deployment marker - e.g. the latest release tag                                                                 |
+| `accountId`     | optional | The account number the application falls under. This could also be a subaccount.                                                         |
+
+## Example usage
+
+```yaml
+# Add a New Relic application deployment marker on release
+on:
+  - release
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Apply New Relic deployment marker
+        uses: sanderblue/newrelic-deployment-marker@master
+        with:
+          api_key: ${{ secrets.NEW_RELIC_API_KEY }}
+          applicationId: <your application ID>
+          revision: ${{ github.ref }}-${{ github.sha }}  # optional
+          region: US                                     # optional
+          accountId: <your New Relic account ID>         # optional
+```

action.yaml

@@ -0,0 +1,32 @@
+name: 'New Relic Application Deployment Marker'
+author: 'New Relic'
+description: 'Apply a New Relic application deployment marker to an application that is monitored by New Relic.'
+branding:
+  icon: 'upload-cloud'
+  color: 'blue'
+inputs:
+  api_key:
+    description: 'Your New Relic Personal API Key.'
+    required: true
+  region:
+    description: 'The geographical region for your New Relic account - US or EU. Default: US'
+    required: false
+    default: US
+  applicationId:
+    description: 'The application ID to apply the deployment marker.'
+    required: true
+  revision:
+    description: 'Custom revision information to add to the deployment marker - e.g. the latest tag.'
+    required: false
+  accountId:
+    description: 'Your New Relic account ID. This account ID should have access to the specified application.'
+    required: false
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  env:
+    NEW_RELIC_API_KEY: ${{ inputs.api_key }}
+    NEW_RELIC_REGION: ${{ inputs.region }}
+    APPLICATION_ID: ${{ inputs.applicationId }}
+    REVISION: ${{ inputs.revision }}
+    ACCOUNT_ID: ${{ inputs.accountId }}

entrypoint.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+RED='\033[0;31m'
+NO_COLOR='\033[0m'
+
+result=$(newrelic apm deployment create --applicationId "${APPLICATION_ID}" --revision "${REVISION}" 2>&1)
+
+exitStatus=$?
+
+if [ $exitStatus -ne 0 ]; then
+  printf "${RED}Error:${NO_COLOR} $result"
+fi
+
+exit $exitStatus