antithesishq / antithesis-trigger-action

An action that triggers an Antithesis notebook / test workflow

Antithesis trigger GitHub Action

This action runs an Antithesis test run as a step in a GitHub Action workflow job.

What is Antithesis?

Antithesis is a continuous reliability platform that autonomously searches for problems in your software within a simulated environment. Every problem we find can be perfectly reproduced, allowing for efficient debugging of even the most complex problems.

Usage

This action takes the following inputs to configure its behavior. You can see an example usage here in our demo project glitch-grid.

Instructions

1. Add your Antithesis username and password to your GitHub repository secrets and variables. Navigate to your repository action secrets settings found here. Add a new repository secret, and give it the name ANTITHESIS_USER_NAME to store your Antithesis username. Add another secret, and give it the name ANTITHESIS_PASSWORD to store your Antithesis password.

2. Create a limited scope PAT token to enable Antithesis to post back results to GitHub. Navigate to your fine-grained access token settings found here and create a limited scope fine-grained access token with minimal permissions. It is recommended to limit the token to the repository running the workflow and to only grant the token permission to read the repository metadata and to read/write the commit status. For example:

3. Add your token to the repository secrets as you did in step one, and give it the name GH_PAT.

4. Call the Antithesis Trigger Action in your workflow file by adding the following code:

    - name: Run Antithesis Tests
      uses: antithesishq/antithesis-trigger-action@v0.5
      with:
        notebook_name: my-test-notebook-name
        tenant: my-subdomain-name
        username: ${{ secrets.ANTITHESIS_USERNAME }}
        password: ${{ secrets.ANTITHESIS_PASSWORD }}
        github_token: ${{ secrets.GH_PAT }}
        config_image: myconfigcontainer@digest
        images: mycontainer1@digest;mycontainer2:tag
        description: my-desc
        email_recipients: [e-mail];[e-mail]
        additional_parameters: |-
          parameter1_name=parameter1_value
          parameter2_name=parameter2_value

Inputs

• notebook_name : the name of your test that will be run (provided by Antithesis)
• tenant : the subdomain for your tenant (e.g. $TENANT_NAME.antithesis.com)
• config_image : The image version that Antithesis will pull from the container registry for the config image. This should be a single image version formatted in the same way as those in the antithesis.images parameter.
• images : The image versions that Antithesis will use to build your test environment. The images are specified as an optional registry, a container name and either a digest (which is recommended) or a tag. A ‘;’ delimited list. Each entry is in this format: [REGISTRY/]NAME[:TAG|@DIGEST].
• description : A string description of your test run. The description will be in the headers of the generated report and of any emails triggered by the test run.
• email_recipients : A semi-colon delimited list of the email addresses for the recipients who will be emailed links to the triage report produced by this test run. If this parameter is not specified, emails will be sent to the default users set up for the test.
• additional_parameters : A newline-seperated list of additional parameters to be sent to the test run.