newrelic / deployment-marker-action

Github Action for recording a Deployment Marker in New Relic
https://github.com/marketplace/actions/new-relic-application-deployment-marker
Apache License 2.0
58 stars 23 forks source link

Minimum required fields documentation incorrect #47

Open marvaul opened 1 year ago

marvaul commented 1 year ago

The fields documented are prompting an error. I guess it should be:

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.2.0
        with:
          apiKey: ${{ secrets.NEW_RELIC_API_KEY }}
          region: "US"
          guid: ${{ secrets.NEW_RELIC_DEPLOYMENT_ENTITY_GUID }}
          version: "${{ env.RELEASE_VERSION }}"
          user: "${{ github.actor }}"
marvaul commented 1 year ago

Unfortunately I cannot push, as I would have supplied the PR.

pranav-new-relic commented 1 year ago

Hi @marvaul - thank you for reporting this issue. We see that the workflow you've specified in the description has been adapted from this piece in the documentation - however, can you give us a little more detail on which attribute (you think) could be causing the error you're seeing, and some details on the error you're seeing too? This would help us understand the issue better - thanks!