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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,10 +1,13 @@
1
- name: Use docassemble image version
1
+ name: Sandbox with AL da image version
2
2
 
3
3
  on:
4
4
  push:
5
5
  pull_request:
6
6
  workflow_dispatch:
7
7
  inputs:
8
+ tags:
9
+ required: False
10
+ description: 'Optional. Use a "tag expression" specify which tagged tests to run (https://cucumber.io/docs/cucumber/api/#tag-expressions)'
8
11
  show_docker_output:
9
12
  required: false
10
13
  default: false
@@ -16,10 +19,12 @@ on:
16
19
  description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
17
20
  required: false
18
21
  default: false
22
+ schedule:
23
+ - cron: "0 1 * * SUN"
19
24
 
20
25
  jobs:
21
26
 
22
- github-server-tests:
27
+ sandbox-al-tests:
23
28
  # Avoids running double tests when someone on the team makes a pull request
24
29
  # 1: Trigger job on push or dispatch from this repository
25
30
  # 2: Trigger job on pull request from a fork
@@ -42,7 +47,7 @@ jobs:
42
47
  uses: ./action_for_github_server
43
48
  with:
44
49
  SHOW_DOCKER_OUTPUT: "${{ github.event.inputs.show_docker_output }}"
45
- DOCASSEMBLE_IMAGE: "ghcr.io/suffolklitlab/docassemble:sha-7d13853"
50
+ DOCASSEMBLE_IMAGE: "ghcr.io/suffolklitlab/docassemble:latest"
46
51
  - run: echo "ALKiln finished starting the isolated GitHub docassemble server"
47
52
  shell: bash
48
53
 
@@ -1,4 +1,4 @@
1
- name: GitHub server installation
1
+ name: Sandbox with latest da image
2
2
 
3
3
  on:
4
4
  push:
@@ -24,7 +24,7 @@ on:
24
24
 
25
25
  jobs:
26
26
 
27
- github-server-tests:
27
+ sandbox-da-tests:
28
28
  #### Developer note: If you have both `push` and `pull_request` in the
29
29
  #### `on` section (above), this avoids running double tests when someone
30
30
  #### on the team makes a pull request
@@ -159,7 +159,7 @@ jobs:
159
159
  #### Developer note: You can probably leave the rest out
160
160
  #### To learn more, see https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
161
161
  ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
162
- ALKILN_VERSION: "da_version"
162
+ # ALKILN_VERSION:
163
163
 
164
164
  #### Developer note: Example of making an issue when tests fail
165
165
  #### that includes the text of the failure output file
@@ -13,7 +13,7 @@ on:
13
13
 
14
14
  jobs:
15
15
 
16
- puppeteer-tests:
16
+ alkiln-tests:
17
17
  #### Developer note: If you have both `push` and `pull_request` in the
18
18
  #### `on` section (above), this avoids running double tests when someone
19
19
  #### editing the repository makes a pull request
@@ -80,4 +80,4 @@ jobs:
80
80
  # want to check up on this.
81
81
  ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
82
82
  #### Developer note: You can probably leave this out
83
- ALKILN_VERSION: "da_version"
83
+ # ALKILN_VERSION:
package/CHANGELOG.md CHANGED
@@ -43,7 +43,9 @@ Format:
43
43
  -
44
44
  -->
45
45
 
46
- ## [Unreleased]
46
+ <!-- ## [Unreleased] -->
47
+
48
+ ## [5.17.1] - 2026-10-13
47
49
 
48
50
  ### Changed
49
51
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@suffolklitlab/alkiln",
3
- "version": "5.17.0-fix-da-1-10-n",
3
+ "version": "5.17.1",
4
4
  "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
5
5
  "main": "lib/index.js",
6
6
  "scripts": {
@@ -1,188 +0,0 @@
1
- name: GitHub server installation
2
-
3
- on:
4
- push:
5
- pull_request:
6
- workflow_dispatch:
7
- inputs:
8
- tags:
9
- required: False
10
- description: 'Optional. Use a "tag expression" specify which tagged tests to run (https://cucumber.io/docs/cucumber/api/#tag-expressions)'
11
- show_docker_output:
12
- required: false
13
- default: false
14
- type: boolean
15
- 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.'
16
- #### Developer note: You can probably leave this out
17
- enable_tmate:
18
- type: boolean
19
- description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
20
- required: false
21
- default: false
22
- schedule:
23
- - cron: "0 1 * * SUN"
24
-
25
- jobs:
26
-
27
- github-server-tests:
28
- #### Developer note: If you have both `push` and `pull_request` in the
29
- #### `on` section (above), this avoids running double tests when someone
30
- #### on the team makes a pull request
31
- # 1: Trigger job on push or dispatch from this repository
32
- # 2: Trigger job on pull request from a fork
33
- if: (
34
- github.event_name != 'pull_request'
35
- && ! github.event.pull_request.head.repo.fork
36
- ) || (
37
- github.event_name == 'pull_request'
38
- && github.event.pull_request.head.repo.fork
39
- )
40
- runs-on: ubuntu-latest
41
-
42
- #### Developer note: You can probably leave out these specific
43
- #### environment variables. You may not even need the `env`
44
- #### keyword or values at all. See
45
- #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing#env-vars
46
- env:
47
- NORMAL_USER_EMAIL: alkiln@example.com
48
- NORMAL_USER_PASSWORD: User123^
49
- WRONG_EMAIL: wrong_email@example.com
50
- WRONG_PASSWORD: wrong_password
51
- INVALID_API_KEY: invalidAPIkey
52
- EMPTY_STRING: ""
53
- SECRET_VAR1: secret-var1-value
54
- SECRET_VAR2: secret-var2-value
55
- SECRET_FOR_MISSING_FIELD: secret for missing field
56
-
57
- steps:
58
- # Place the root directory in this branch to access
59
- # relative paths to action files
60
- - uses: actions/checkout@v4
61
-
62
- - name: "ALKiln - Start the isolated temporary docassemble server on GitHub"
63
- id: github_server
64
- #### Developer note: you'll need to replace `uses: ./action_for_github_server`
65
- #### with the path to ALKiln’s repository name and branch name. For example,
66
- #### for version 5, use the branch name `v5`:
67
- #### `uses: suffolkLITLab/ALKiln/action_for_github_server@v5`
68
- uses: ./action_for_github_server
69
- with:
70
- #### Developer note: Set this to "true" to show docker logs and
71
- #### allow ALKiln to create the docker logs output artifact.
72
- SHOW_DOCKER_OUTPUT: "${{ github.event.inputs.show_docker_output }}"
73
- #### Developer note: You can probably leave this out
74
- CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
75
- DOCASSEMBLE_IMAGE: "ghcr.io/suffolklitlab/docassemble:latest"
76
- - run: echo "ALKiln finished starting the isolated GitHub docassemble server"
77
- shell: bash
78
-
79
- #### Developer note: You can probably leave this out
80
- - name: "Add a low-level user and their API key (in an env var)"
81
- env:
82
- SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
83
- KEY: ${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}
84
- run: |
85
- # Create user and their API key
86
-
87
- # Install json processor
88
- sudo apt-get install jq
89
-
90
- # https://docassemble.org/docs/api.html#user_new
91
- user_data=$(curl -X POST \
92
- ${{ env.SERVER_URL }}/api/user/new \
93
- -H 'Content-Type: application/json' \
94
- -d '{
95
- "key": "${{ env.KEY }}",
96
- "username": "${{ env.NORMAL_USER_EMAIL }}",
97
- "password": "${{ env.NORMAL_USER_PASSWORD }}"
98
- }')
99
- echo "User data:"
100
- echo "$user_data"
101
-
102
- user_id=$(echo "$user_data" | jq '.user_id' -r)
103
-
104
- # https://docassemble.org/docs/api.html#api_user_user_id_api_post
105
- new_key_with_quotes=$(curl -X POST \
106
- ${{ env.SERVER_URL }}/api/user/"$user_id"/api \
107
- -H 'Content-Type: application/json' \
108
- -d '{
109
- "key": "${{ env.KEY }}",
110
- "name": "alkiln_key",
111
- "method": "none"
112
- }')
113
- echo "new key (watch out, this contains actual quotation marks): $new_key_with_quotes"
114
- no_end_quote="${new_key_with_quotes%\"}"
115
- unquoted="${no_end_quote#\"}"
116
- echo "unquoted: $unquoted"
117
-
118
- echo "NORMAL_USER_API_KEY=$unquoted" >> "$GITHUB_ENV"
119
-
120
- #### Developer note: You can probably leave this out
121
- ## Optional debugging to explore things like docker issues
122
- #- name: Docker debug tmate session
123
- # #if: ${{ failure() && github.event.inputs.enable_tmate == 'true' }}
124
- # uses: mxschmitt/action-tmate@v3
125
-
126
- #### Developer note: You can probably leave this out
127
- - name: "Create other env vars for our own tests from server output"
128
- run: |
129
- echo "USER1_EMAIL=${{ steps.github_server.outputs.DA_ADMIN_EMAIL }}" >> $GITHUB_ENV
130
- echo "USER1_PASSWORD=${{ steps.github_server.outputs.DA_ADMIN_PASSWORD }}" >> $GITHUB_ENV
131
-
132
- #### Developer note:
133
- #### Example of working with the docker container after it's been
134
- #### started. For example, you can make more users with different
135
- #### permissions and passwords
136
- #- name: Work with docker
137
- # run: |
138
- # container_name=$(docker ps --format '{{.Names}}' | head -n 1)
139
- # echo "container_name is $container_name"
140
-
141
- - name: "Run ALKiln tests"
142
- if: ${{ success() }}
143
- id: alkiln
144
- #### Developer note: you'll need to replace `uses: ./`
145
- #### with the path to ALKiln’s repository name and branch name. For example,
146
- #### for version 5, use the branch name `v5`: `uses: suffolkLITLab/ALKiln@v5`
147
- uses: ./
148
- #### Developer note: You can probably leave out this `env` section
149
- env:
150
- # Internal: docassemble changes sometimes break @a11y tests. That is
151
- # a da problem, not ours. We will trigger these tests manually when we
152
- # want to check up on this.
153
- ALKILN_TAG_EXPRESSION: "${{ (github.event.inputs.tags && format('{0}', github.event.inputs.tags)) || '(not @error) and (not @temp_error)' }}"
154
- with:
155
- #### Developer note: Required inputs. See
156
- #### https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#sandbox-inputs
157
- SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
158
- DOCASSEMBLE_DEVELOPER_API_KEY: "${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}"
159
- INSTALL_METHOD: "server"
160
- #### Developer note: You can probably leave the rest out
161
- #### To learn more, see https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
162
- ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
163
- ALKILN_VERSION: "da_version"
164
-
165
- #### Developer note: Example of making an issue when tests fail
166
- #### that includes the text of the failure output file
167
- #### See https://cli.github.com/manual/gh_issue_create for more details
168
- - shell: bash
169
- if: ${{ failure() }}
170
- env:
171
- GH_TOKEN: ${{ github.token }}
172
- PATH_TO_REPORT_LOG_FILE: "${{ steps.alkiln.outputs.PATH_TO_REPORT_LOG_FILE }}"
173
- PATH_TO_UNEXPECTED_RESULTS_FILE: "${{ steps.alkiln.outputs.PATH_TO_UNEXPECTED_RESULTS_FILE }}"
174
- PATH_TO_DEBUG_LOG_FILE: "${{ steps.alkiln.outputs.PATH_TO_DEBUG_LOG_FILE }}"
175
- run: |
176
- # Make an issue with file contents or 'no file' message as part of the body
177
-
178
- if [ -f "${{ env.PATH_TO_UNEXPECTED_RESULTS_FILE }}" ]; then
179
- UNEXPECTED_2=$(cat "${{ env.PATH_TO_UNEXPECTED_RESULTS_FILE }}")
180
- else
181
- UNEXPECTED_2="unexpected_results.txt does not exist. Something other than the interview tests may have failed."
182
- fi
183
-
184
- gh issue create --body "An ALKiln test run failed. See the action at ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}.
185
-
186
- ### Results:
187
-
188
- $UNEXPECTED_2" --repo "$GITHUB_REPOSITORY" --label "testing" --title "ALKiln tests failed"