GitHub Action for Jellyfish DevOps Metrics Reporting

Use this action to report DevOps metrics to Jellyfish. Based on the TypeScript Action Template and the Jellyfish DevOps Metrics Documentation

Using the action

Add the following step to your actions workflow. Details on the arguments available at https://help.jellyfish.co/hc/en-us/articles/9281148741901-Sending-deployment-data-via-the-API-s-Deployment-POST-Endpoint

steps:
  - uses: CharlieHealth/jellyfish-devops-action@v2.0.0
    with:
      name: Prod deployment for my-app
      apiToken: ${{ secrets.JELLYFISH_API_KEY }}
      referenceId: ${{ github.sha }}
      sourceUrl: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
      isSuccessful: True
      repoName: ${{ github.event.repository.full_name }}
      commitShas: |
        ${{ github.sha }}
      labels: |
        team:testTeam
        app:testApp
        env:testEnv
      shouldBackfillCommits: False
      isDryRun: True

Development

First, you'll need to have a reasonably modern version of node handy. This won't work with versions older than 9, for instance.

Install the dependencies

$ npm install

Build the typescript and package it for distribution

$ npm run build && npm run package

Run the tests ✔️

$ npm test

 PASS  __tests__/main.test.ts
  ✓ test report_deployment function (10 ms)

...

Publish to a distribution branch

To publish your package, run the package command. Then checkin and merge changes to the dist folder and create a release branch

$ npm run package