playground.yml

name: Playground installation

on:
  push:
  pull_request:
  workflow_dispatch:
    inputs:
      tags:
        required: False
        description: 'Optional. Use a "tag expression" specify which tagged tests to run (https://cucumber.io/docs/cucumber/api/#tag-expressions)'
        default: ''

jobs:

  puppeteer-tests:
    #### Developer note: If you have both `push` and `pull_request` in the
    #### `on` section (above), this avoids running double tests when someone
    #### editing the repository makes a pull request
    # 1: Trigger job on push or dispatch from this repository
    # 2: Trigger job on pull request from a fork
    if: (
          github.event_name != 'pull_request'
          && ! github.event.pull_request.head.repo.fork
        ) || (
          github.event_name == 'pull_request'
          && github.event.pull_request.head.repo.fork
        )
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [20.x]

    env:
      #### Developer note: We recommend turning these into environment
      #### variables before using them as inputs later
      SERVER_URL: ${{ secrets.SERVER_URL }}
      DOCASSEMBLE_DEVELOPER_API_KEY: ${{ secrets.DOCASSEMBLE_DEVELOPER_API_KEY }}

      #### Developer note: You can probably leave out these specific
      #### environment variables.
      PLAYGROUND_EMAIL: ${{ secrets.PLAYGROUND_EMAIL }}
      PLAYGROUND_PASSWORD: ${{ secrets.PLAYGROUND_PASSWORD }}
      PLAYGROUND_ID: ${{ secrets.PLAYGROUND_ID }}
      USER1_EMAIL: ${{ secrets.USER1_EMAIL }}
      USER1_PASSWORD: ${{ secrets.USER1_PASSWORD }}
      NORMAL_USER_EMAIL: ${{ secrets.USER_NO_PERMISSIONS_EMAIL }}
      NORMAL_USER_PASSWORD: ${{ secrets.USER_NO_PERMISSIONS_PASSWORD }}
      NORMAL_USER_API_KEY: ${{ secrets.USER_NO_PERMISSIONS_API_KEY }}
      INVALID_API_KEY: invalidAPIkey
      WRONG_EMAIL: wrong_email@example.com
      WRONG_PASSWORD: wrong_password
      EMPTY_STRING: ""
      SECRET_VAR1: secret-var1-value
      SECRET_VAR2: secret-var2-value
      SECRET_FOR_MISSING_FIELD: secret for missing field
      # Internal
      _ORIGIN: github

    name: Run ALKiln tests
    steps:
      #### Developer note: You can probably leave this out
      # Place the root directory in this branch to access relative paths to action files
      - uses: actions/checkout@v4

      #### Developer note: you'll need to replace `uses: ./`
      #### with the path to ALKiln’s repository name and branch name. For example,
      #### for version 5, use the branch name `v5`: `uses: suffolkLITLab/ALKiln@v5`
      - uses: ./
        #### Developer note: You can probably leave this out
        env:
          ALKILN_TAG_EXPRESSION: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @error) and (not @temp_error)' }}"
        with:
          #### Developer note: Required ALKiln inputs. You can read more at
          #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#githubNyou-inputs
          SERVER_URL: "${{ env.SERVER_URL }}"
          DOCASSEMBLE_DEVELOPER_API_KEY: "${{ env.DOCASSEMBLE_DEVELOPER_API_KEY }}"
          #### Developer note: See https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
          #### You can probably leave this out
          # Internal: docassemble changes sometimes break @a11y tests. That is
          # a da problem, not ours. We will trigger these tests manually when we
          # want to check up on this.
          ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
          #### Developer note: You can probably leave this out
          ALKILN_VERSION: download