Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.83 KB

README.md

File metadata and controls

27 lines (20 loc) · 1.83 KB

Test Observability Action

An action to push JUnit files to Ably's test observability server.

Inputs

  • server-url: the server to publish results to - see action.yml for the default value

  • server-auth: authentication key for the server. The ably GitHub organization has an org-wide TEST_OBSERVABLILITY_SERVER_AUTH_KEY secret. It is recommended that you make this secret available to your repository and then use this secret as the server-auth input.

  • path: where to look for *.junit files

  • github-token (optional): A GitHub access token. If provided, the action will perform a GitHub API call in order to discover the web URL for the current job, and will include this URL in the observability server upload. If the repository is private you must use an access token with the repo scope.

  • job-name (optional): The name property of the object corresponding to the current job in the response from the "list jobs for a workflow run attempt" GitHub API. See the sample workflow for an example of how to calculate this value. If there is more than one object in the response whose name property equals this value, the action will fail.

    If you specify github-token but not job-name, and the response from this API contains more than one job, the action will fail.

Example

Workflow step:

- name: Upload test results
  if: always()
  uses: ably/test-observability-action@v1
  with:
    server-auth: ${{ secrets.TEST_OBSERVABLILITY_SERVER_AUTH_KEY }}
    path: '.'
    github-token: ${{ secrets.GITHUB_TOKEN }}