@suffolklitlab/alkiln 5.16.1 → 5.17.0-fix-da-1-10-n

package/.github/workflows/da_image_v_sha_7d13853.yml

@@ -31,9 +31,6 @@ jobs:
           && github.event.pull_request.head.repo.fork
         )
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [24.x]
       
     steps:
       # Place the root directory in this branch to access relative paths to

package/.github/workflows/github_server.yml

@@ -19,6 +19,8 @@ on:
         description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
         required: false
         default: false
+  schedule:
+    - cron: "0 1 * * SUN"
 
 jobs:
 
@@ -36,9 +38,6 @@ jobs:
           && github.event.pull_request.head.repo.fork
         )
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [24.x]
 
     #### Developer note: You can probably leave out these specific
     #### environment variables. You may not even need the `env`
@@ -160,7 +159,7 @@ jobs:
           #### Developer note: You can probably leave the rest out
           #### To learn more, see https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
           ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
-          # ALKILN_VERSION: 
+          ALKILN_VERSION: "da_version"
 
       #### Developer note: Example of making an issue when tests fail
       #### that includes the text of the failure output file

package/.github/workflows/github_server_al_da_latest.yaml

@@ -0,0 +1,188 @@
+name: GitHub server 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)'
+      show_docker_output:
+        required: false
+        default: false
+        type: boolean
+        description: 'Show the docker logs while building the GitHub server container. It will also save the docker log artifact. This might show sensitive config information.'
+      #### Developer note: You can probably leave this out
+      enable_tmate:
+        type: boolean
+        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
+        required: false
+        default: false
+  schedule:
+    - cron: "0 1 * * SUN"
+
+jobs:
+
+  github-server-tests:
+    #### Developer note: If you have both `push` and `pull_request` in the
+    #### `on` section (above), this avoids running double tests when someone
+    #### on the team 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
+
+    #### Developer note: You can probably leave out these specific
+    #### environment variables. You may not even need the `env`
+    #### keyword or values at all. See
+    #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing#env-vars
+    env:
+      NORMAL_USER_EMAIL: alkiln@example.com
+      NORMAL_USER_PASSWORD: User123^
+      WRONG_EMAIL: wrong_email@example.com
+      WRONG_PASSWORD: wrong_password
+      INVALID_API_KEY: invalidAPIkey
+      EMPTY_STRING: ""
+      SECRET_VAR1: secret-var1-value
+      SECRET_VAR2: secret-var2-value
+      SECRET_FOR_MISSING_FIELD: secret for missing field
+      
+    steps:
+      # Place the root directory in this branch to access
+      # relative paths to action files
+      - uses: actions/checkout@v4
+
+      - name: "ALKiln - Start the isolated temporary docassemble server on GitHub"
+        id: github_server
+        #### Developer note: you'll need to replace `uses: ./action_for_github_server`
+        #### with the path to ALKiln’s repository name and branch name. For example,
+        #### for version 5, use the branch name `v5`:
+        #### `uses: suffolkLITLab/ALKiln/action_for_github_server@v5`
+        uses: ./action_for_github_server
+        with:
+          #### Developer note: Set this to "true" to show docker logs and
+          #### allow ALKiln to create the docker logs output artifact.
+          SHOW_DOCKER_OUTPUT: "${{ github.event.inputs.show_docker_output }}"
+          #### Developer note: You can probably leave this out
+          CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
+          DOCASSEMBLE_IMAGE: "ghcr.io/suffolklitlab/docassemble:latest"
+      - run: echo "ALKiln finished starting the isolated GitHub docassemble server"
+        shell: bash
+
+      #### Developer note: You can probably leave this out
+      - name: "Add a low-level user and their API key (in an env var)"
+        env:
+          SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
+          KEY: ${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}
+        run: |
+          # Create user and their API key
+
+          # Install json processor
+          sudo apt-get install jq
+
+          # https://docassemble.org/docs/api.html#user_new
+          user_data=$(curl -X POST \
+            ${{ env.SERVER_URL }}/api/user/new \
+            -H 'Content-Type: application/json' \
+            -d '{
+              "key": "${{ env.KEY }}",
+              "username": "${{ env.NORMAL_USER_EMAIL }}",
+              "password": "${{ env.NORMAL_USER_PASSWORD }}"
+            }')
+          echo "User data:"
+          echo "$user_data"
+
+          user_id=$(echo "$user_data" | jq '.user_id' -r)
+
+          # https://docassemble.org/docs/api.html#api_user_user_id_api_post
+          new_key_with_quotes=$(curl -X POST \
+            ${{ env.SERVER_URL }}/api/user/"$user_id"/api \
+            -H 'Content-Type: application/json' \
+            -d '{
+              "key": "${{ env.KEY }}",
+              "name": "alkiln_key",
+              "method": "none"
+            }')
+          echo "new key (watch out, this contains actual quotation marks): $new_key_with_quotes"
+          no_end_quote="${new_key_with_quotes%\"}"
+          unquoted="${no_end_quote#\"}"
+          echo "unquoted: $unquoted"
+
+          echo "NORMAL_USER_API_KEY=$unquoted" >> "$GITHUB_ENV"
+
+      #### Developer note: You can probably leave this out
+      ## Optional debugging to explore things like docker issues
+      #- name: Docker debug tmate session
+      #  #if: ${{ failure() && github.event.inputs.enable_tmate == 'true' }}
+      #  uses: mxschmitt/action-tmate@v3
+
+      #### Developer note: You can probably leave this out
+      - name: "Create other env vars for our own tests from server output"
+        run: |
+          echo "USER1_EMAIL=${{ steps.github_server.outputs.DA_ADMIN_EMAIL }}" >> $GITHUB_ENV
+          echo "USER1_PASSWORD=${{ steps.github_server.outputs.DA_ADMIN_PASSWORD }}" >> $GITHUB_ENV
+
+      #### Developer note:
+      #### Example of working with the docker container after it's been
+      #### started. For example, you can make more users with different
+      #### permissions and passwords
+      #- name: Work with docker
+      #  run: |
+      #    container_name=$(docker ps --format '{{.Names}}' | head -n 1)
+      #    echo "container_name is $container_name"
+
+      - name: "Run ALKiln tests"
+        if: ${{ success() }}
+        id: alkiln
+        #### 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 out this `env` section
+        env:
+          # 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: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @error) and (not @temp_error)' }}"
+        with:
+          #### Developer note: Required inputs. See
+          #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sandbox-inputs
+          SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
+          DOCASSEMBLE_DEVELOPER_API_KEY: "${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}"
+          INSTALL_METHOD: "server"
+          #### Developer note: You can probably leave the rest out
+          #### To learn more, see https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
+          ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
+          ALKILN_VERSION: "da_version"
+
+      #### Developer note: Example of making an issue when tests fail
+      #### that includes the text of the failure output file
+      #### See https://cli.github.com/manual/gh_issue_create for more details
+      - shell: bash
+        if: ${{ failure() }}
+        env:
+          GH_TOKEN: ${{ github.token }}
+          PATH_TO_REPORT_LOG_FILE: "${{ steps.alkiln.outputs.PATH_TO_REPORT_LOG_FILE }}"
+          PATH_TO_UNEXPECTED_RESULTS_FILE: "${{ steps.alkiln.outputs.PATH_TO_UNEXPECTED_RESULTS_FILE }}"
+          PATH_TO_DEBUG_LOG_FILE: "${{ steps.alkiln.outputs.PATH_TO_DEBUG_LOG_FILE }}"
+        run: |
+          # Make an issue with file contents or 'no file' message as part of the body
+
+          if [ -f "${{ env.PATH_TO_UNEXPECTED_RESULTS_FILE }}" ]; then
+            UNEXPECTED_2=$(cat "${{ env.PATH_TO_UNEXPECTED_RESULTS_FILE }}")
+          else
+            UNEXPECTED_2="unexpected_results.txt does not exist. Something other than the interview tests may have failed."
+          fi
+
+          gh issue create --body "An ALKiln test run failed. See the action at ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}.
+
+          ### Results:
+
+          $UNEXPECTED_2" --repo "$GITHUB_REPOSITORY" --label "testing" --title "ALKiln tests failed"

package/.github/workflows/playground.yml

@@ -27,9 +27,6 @@ jobs:
           && github.event.pull_request.head.repo.fork
         )
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [24.x]
 
     env:
       #### Developer note: We recommend turning these into environment
@@ -83,4 +80,4 @@ jobs:
           # want to check up on this.
           ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
           #### Developer note: You can probably leave this out
-          # ALKILN_VERSION: 
+          ALKILN_VERSION: "da_version"

package/CHANGELOG.md

@@ -43,7 +43,42 @@ Format:
 - 
 -->
 
-<!-- ## [Unreleased] -->
+## [Unreleased]
+
+### Changed
+
+- Updated to work with docassemble v1.10.n while being backwards compatible. See [issue #1117](https://github.com/SuffolkLITLab/ALKiln/issues/1117)
+  - Unable to find some continue buttons
+    - Single-line fields like `yesno: likes_good_things`
+    - Buttons created with `buttons:`
+    - Continue buttons on signature pages
+  - Unable to sign with a name
+  - Unable to upload files
+  - Created infinite loop with 'Restart' button
+- Changed the internal behavior of the experimental Step "I can't continue" from testing for errors after the previous Step (whatever it happened to be) to attempting to continue. Failure to continue causes success of the Step.
+
+### Internal
+
+- Added a workflow to test using an Assembly Line docker image
+- Test using a cron job to catch failures more regularly
+- Remove unsupported Step "Then I arrive at the next page" and moved responsibility to Steps that imply they navigate
+- Fixed typo in fixture
+
+## [5.17.0] - 2026-09-10
+
+### Changed
+
+- GitHub action release: Restored our GitHub action's default for ALKiln version to the latest version 5 again. Released first on GitHub actions. NPM release will come in time, but npm has no impact on GitHub action releases.
+
+### Fixed
+
+- Fixed GitHub+You action outdated docassemble cli version causing Scenario timeouts.
+- Part 1 of detecting custom AL error screen: Story Table now catches `al_custom_error_screen` error. Previously, Story Tables that ran into this screen would get stuck on the AL error page infinitely. Next steps: Linear Steps may need additional development. Currently linear Steps succeed even when they run into AL's error page. That bears additional discussion. See [issue #656](https://github.com/SuffolkLITLab/ALKiln/issues/656) and [PR #1116](https://github.com/SuffolkLITLab/ALKiln/pull/1116).
+
+### Internal
+
+- Simplify workflow files by removing `node` env setup (leaving it to the actions)
+- Updated both of our actions' dependencies (the checkout, setup-node, setup-python, upload-artifacts, download-artifacts actions). Closes [#1095](https://github.com/suffolkLITLab/aLKiln/issues/1095). Once again, action related.
 
 ## [5.16.1] - 2026-06-01
 

package/action.yml

@@ -14,7 +14,7 @@ inputs:
   ALKILN_VERSION:
     description: 'Version of ALKiln to get from npm.'
     required: false
-    default: '5.15.4'
+    default: '^5.0.0'
   MAX_SECONDS_FOR_SETUP:
     description: "Amount of time to give the Project to upload your package's GitHub code."
     required: false
@@ -32,7 +32,7 @@ inputs:
   DOCASSEMBLECLI_VERSION:
     description: "The version of docassemblecli to install."
     required: false
-    default: "0.0.17"
+    default: "0.0.25"
   ALKILN_MAX_RANDOM_TESTS_PER_SCENARIO:
     description: "The maximum number of tests ALKiln will generate for every Scenario that can generate tests."
     required: false
@@ -59,7 +59,7 @@ runs:
   using: "composite"
   steps:
     # Place the root directory in this branch
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
 
     # Set environment variables
     - name: "💡 ALK0023 INFO: Set environment variables"
@@ -111,7 +111,7 @@ runs:
 
     # Install ALKiln during GitHub workflow
     - name: "💡 ALK0025 INFO: Set up node"
-      uses: actions/setup-node@v5
+      uses: actions/setup-node@v6
       with:
         node-version: "24.x"
         package-manager-cache: false
@@ -155,7 +155,7 @@ runs:
 
     # Install package on playground
     # Don't rely on the environment's version of python
-    - uses: actions/setup-python@v5
+    - uses: actions/setup-python@v6
       if: ${{ inputs.INSTALL_METHOD == 'playground' }}
       with:
         python-version: '3.10'
@@ -213,7 +213,7 @@ runs:
     # Upload artifacts that subscribers can download on the Actions summary page
     - name: "💡 ALK0033 INFO: Upload artifacts folder"
       if: ${{ always() }}
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v7
       with:
         name: ${{ env.ARTIFACT_FOLDER }}
         path: ./alkiln-*
@@ -221,7 +221,7 @@ runs:
     # Download artifacts folder internally to create action output
     - name: "💡 ALK0183 INFO: Get uploaded artifacts folder"
       if: ${{ always() }}
-      uses: actions/download-artifact@v4
+      uses: actions/download-artifact@v8
       with:
         name: ${{ env.ARTIFACT_FOLDER }}
 

package/action_for_github_server/action.yml

@@ -49,7 +49,7 @@ runs:
   using: "composite"
   steps:
       # Place the root directory in this branch
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
 
       - shell: bash
         run: |
@@ -253,7 +253,7 @@ runs:
           done
 
       # Don't rely on the environment's version of python
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: '3.10'
       # No output
@@ -285,7 +285,7 @@ runs:
           echo "$(docker output docassemble_container)" >> "${{ env.DEBUG_LOGS_PATH }}"
       - name: "💡 ALK0020 INFO: Upload artifacts folder"
         if: ${{ always() && env.OUTPUT_DOCKER == 'true' }}
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: ${{ env.GITHUB_SERVER_ARTIFACT_NAME }}
           path: ${{ env.DEBUG_LOGS_PATH }}

package/lib/docassemble/docassemble_api_interface.js

@@ -377,6 +377,9 @@ da_i.get_interview = async function ({ interview = {}, api_keys = [], options =
           log.debug({ code: `ALK0193`, context, },
             `Status ${ response.status }. Got ${ response.data.items[0].session }.`
           );
+          // Discuss: Do we need to handle pagination? Think most recent
+          // sessions are listed first, so perhaps not a problem.
+          // https://docassemble.org/docs/api.html#user_interviews
           return response.data.items[0];
         } else {
           log.debug({ code: `ALK0194`, context, },