deployment-marker-action

KO | EN

gitlite — search

#go #android #rust #deep-learning #docker #nodejs #macos #java #cli #vue #awesome-list #security #openai #open-source

deployment-marker-action

(★ 75)

Github Action for recording a Deployment Marker in New Relic

deployment-marker-action 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Community Project header](https://github.com/newrelic/open-source-office/raw/master/examples/categories/images/Community_Project.png)](https://github.com/newrelic/open-source-office/blob/master/examples/categories/index.md#category-community-project)

# New Relic Application 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.

The Action supports two primary NerdGraph API mutations for submitting events:

#### changeTrackingCreateEvent (RECOMMENDED):
Our latest API mutation with the most customizations and flexibility. Track any type of change event including Deployments or any other category and type that you would like to send, such as Feature Flag and Business Events. Add custom attributes to decorate your events with any relevant business metadata. Use our entity search to place change events on entities without needing to specify the entity guid. Customize the marker and activity stream text via `shortDescription` so you can see all the relevant details in the New Relic UI at a glance.
This will create a `ChangeTrackingEvent` event.

The `commandType` must be set to `changeTrackingCreateEvent` to enable this functionality. Please refer to the example below for more details and its usage.
For more details about the `changeTrackingCreateEvent` mutation, please refer to our [docs](https://docs.newrelic.com/docs/change-tracking/change-tracking-events/#change-tracking-event-mutation)

#### changeTrackingCreateDeployment (Legacy):
This mutation is designed specifically for submitting legacy `Deployment` events. It represents the older method for sending deployment-focused information to New Relic.
This will create a `Deployment` event. |

## changeTrackingCreateEvent Inputs

| Key                | Required | Default        | Description                                                                                                                                                                                                |
|--------------------|----------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `apiKey`           | yes      | -              | Your New Relic [personal API key](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#personal-api-key).                                                                   |
| `category`         | no       | -              | The category of the change event. For a list of supported categories, [view our docs](https://docs.newrelic.com/docs/change-tracking/change-tracking-events/#supported-types).                             |
| `changelog`        | no       | -              | When category is `Deployment`, a summary of what changed in this deployment, visible in the Change Details page.                                                                                           |
| `commandType`      | yes      | -              | This field lets you track any change event. To use this new API mutation, you must set it to "changeTrackingCreateEvent".                                                                                  |
| `commit`           | no       | -              | When category is `Deployment`, the Commit SHA for this deployment, visible in the Change Details page.                                                                                                     |
| `customAttributes` | no       | -              | Represents key-value pairs of custom attributes in JavaScript object format. Attribute values can be of type string, boolean, or number.                                                                   |
| `deeplink`         | no       | -              | When category is `Deployment`, a deep link to the source which triggered the deployment.                                                                                                                   |
| `description`      | no       | -              | A high-level description of this change event, visible in the Overview page and on the Change Details page when you select an individual change event.                                                     |
| `entitySearch`     | no       | -              | Specify the entity to associate with the change tracking event via query.                                                                                                                                  |
| `featureFlagId`    | no       | -              | When category is `Feature Flag`, the ID of the feature flag associated with the change event. This is required if the category is "Feature Flag".                                                          |
| `groupid`          | no       | -              | A group ID for the change event to link to other change events.                                                                                                                                            |
| `region`           | no       | `US`           | The region of your New Relic account. Default: `US`                                                                                                                                                        |
| `shortDescription` | no       | -              | This field allows you to add your own context to help you quickly identify the change events sent to our system.                                                                                           |
| `timestamp`        | no       | -              | The start time of the change tracking event as the number of milliseconds since the Unix epoch. Defaults to now.                                                                                           |
| `type`             | no       | -              | The type of the change event. For a list of supported types, [view our docs](https://docs.newrelic.com/docs/change-tracking/change-tracking-events/#supported-types)                                       |
| `user`             | no       | `github.actor` | A username to associate with the deployment, visible in the Overview page and on the Change Details page.                                                                                                  |
| `validationFlags`  | no       | -              | Validation flags for the change event (e.g., "`[ALLOW_CUSTOM_CATEGORY_OR_TYPE]`, `[FAIL_ON_FIELD_LENGTH]`, `[FAIL_ON_REST_API_FAILURES]`"). Only applicable if commandType is "changeTrackingCreateEvent". |
| `version`          | no       | -              | When category is `Deployment`, the version of the deployment - e.g. the latest release tag. Note: This is required if the category is set to "Deployment".                                                 |

## changeTrackingCreateDeployment Inputs

| Key              | Required | Default        | Description                                                                                                                                     |
|------------------|----------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `apiKey`         | yes      | -              | Your New Relic [personal API key](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#personal-api-key).        |
| `changelog`      | no       | -              | A summary of what changed in this deployment, visible in the Deployments page.                                                                  |
| `commit`         | no       | -              | The Commit SHA for this deployment, visible in the Deployments page.                                                                            |
| `deeplink`       | no       | -              | A deep link to the source which triggered the deployment.                                                                                       |
| `deploymenttype` | no       | `BASIC`        | The type of deployment. Choose from BASIC, BLUE_GREEN, CANARY, OTHER, ROLLING, or SHADOW.                                                       |
| `description`    | no       | -              | A high-level description of this deployment, visible in the Overview page and on the Deployments page when you select an individual deployment. |
| `groupid`        | no       | -              | A group ID for the deployment to link to other deployments.                                                                                     |
| `guid`           | yes      | -              | The entity GUID to apply the deployment marker.                                                                                                 |
| `region`         | no       | `US`           | The region of your New Relic account. Default: `US`                                                                                             |
| `user`           | no       | `github.actor` | A username to associate with the deployment, visible in the Overview page and on the Deployments page.                                          |
| `version`        | yes      | -              | Metadata to apply to the deployment marker - e.g. the latest release tag                                                                        ||

## Example usage

### GitHub secrets

[GitHub secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#about-encrypted-secrets) assumed to be set:
* `NEW_RELIC_API_KEY` - Personal API key
* `NEW_RELIC_DEPLOYMENT_ENTITY_GUID` - New Relic Entity GUID to create the marker on

### changeTrackingCreateEvent (RECOMMENDED)

The below example outlines the usage of the `changeTrackingCreateEvent` capability. It will allow change events to be reported as rich Change Tracking events, providing more comprehensive metadata and better integration with New Relic's observability platform.
For more details on change tracking event mutation, please refer to our [docs](https://docs.newrelic.com/docs/change-tracking/change-tracking-events/#change-tracking-event-mutation)

```yaml
jobs:
  newrelic:
    runs-on: ubuntu-latest
    name: New Relic ChangeTracking Event 
    steps:
      # This step builds a var with the release tag value to use later
      - name: Set Release Version from Tag
        run: echo "RELEASE_VERSION=${{ github.ref_name }}" >> $GITHUB_ENV
      - name: Test change event deployment marker
        uses: newrelic/deployment-marker-action@v2.6.2
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          commandType: "changeTrackingCreateEvent"
          entitySearch: "id='${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID }}'"
          version: "${{ env.RELEASE_VERSION }}"
          category: 'Deployment'
          type: 'Basic'
          changelog: "https://github.com/${{ github.repository }}/blob/master/CHANGELOG.md"
          commit: "${{ github.sha }}"
          deeplink: "https://example.com/deployment"
          description: "Automated Release via Github Actions"
          user: "${{ github.actor }}"
          groupid: "deploy-group-1"
          timestamp: "${{ github.event.release.published_at }}"
          customAttributes: '{cloud_vendor: "vendor_name", region: "us-east-1", isProd: true, instances: 2}'
```

### changeTrackingCreateDeployment (Legacy):

>*There are a number of [default GitHub environment variables](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables) that are used in these examples as well.*
### Minimum required fields

```yaml
name: Change Tracking Marker
on:
    release:
      types: [published]

jobs:
  newrelic:
    runs-on: ubuntu-latest
    name: New Relic
    steps:
      # This step builds a var with the release tag value to use later
      - name: Set Release Version from Tag
        run: echo "RELEASE_VERSION=${{ github.ref_name }}" >> $GITHUB_ENV
      # This step creates a new Change Tracking Marker
      - name: New Relic Application Deployment Marker
        uses: newrelic/deployment-marker-action@v2.6.2
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          region: "US"
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID }}
          version: "${{ env.RELEASE_VERSION }}"
          user: "${{ github.actor }}"
```

### All input fields

>*In addition to `NEW_RELIC_API_KEY`, this example shows how to target multiple items by storing multiple secrets like "`NEW_RELIC_DEPLOYMENT_ENTITY_GUID_<ID>`", where `<ID>` is the unique identifier for the target item.*

```
NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App123
NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App456
NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App789
```

```yaml
name: Change Tracking Marker
on:
  workflow_dispatch:
  release:
    types: [published]

jobs:
  newrelic:
    runs-on: ubuntu-latest
    name: New Relic
    steps:
      # This step builds a var with the release tag value to use later
      - name: Set Release Version from Tag
        run: echo "RELEASE_VERSION=${{ github.ref_name }}" >> $GITHUB_ENV
      # This step creates a new Change Tracking Marker for App123
      - name: App123 Marker
        uses: newrelic/deployment-marker-action@v2.6.2
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          region: "US"
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App123 }}
          version: "${{ env.RELEASE_VERSION }}"
          changelog: "https://github.com/${{ github.repository }}/blob/master/CHANGELOG.md"
          commit: "${{ github.sha }}"
          description: "Automated Release via Github Actions"
          deploymenttype: "ROLLING"
          groupid: "Workshop App Release: ${{ github.ref_name }}"
          user: "${{ github.actor }}"
      # This step creates a new Change Tracking Marker for App
      - name: App456 Marker
        uses: newrelic/deployment-marker-action@v2.6.2
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          region: "US"
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App456 }}
          version: "${{ env.RELEASE_VERSION }}"
          changelog: "https://github.com/${{ github.repository }}/blob/master/CHANGELOG.md"
          commit: "${{ github.sha }}"
          description: "Automated Release via Github Actions"
          deploymenttype: "ROLLING"
          groupid: "Workshop App Release: ${{ github.ref_name }}"
          user: "${{ github.actor }}"
      # This step creates a new Change Tracking Marker for App789
      - name: App789 Marker
        uses: newrelic/deployment-marker-action@v2.6.2
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          region: "US"
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID_App789 }}
          version: "${{ env.RELEASE_VERSION }}"
          changelog: "https://github.com/${{ github.repository }}/blob/master/CHANGELOG.md"
          commit: "${{ github.sha }}"
          description: "Automated Release via Github Actions"
          deploymenttype: "ROLLING"
          groupid: "Workshop App Release: ${{ github.ref_name }}"
          user: "${{ github.actor }}"
      # When chaining steps together, the deployment id is placed into the GitHub environment 
      - name: View output
        run: echo "${{ env.deploymentId }}"
```

deployment-marker-action

deployment-marker-action 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

deployment-marker-action

deployment-marker-action 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README