@suffolklitlab/alkiln 5.16.0-fix-artifacts → 5.16.0-fix-artifacts-n-pipeline-2
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.
|
@@ -157,37 +157,11 @@ jobs:
|
|
|
157
157
|
SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
|
|
158
158
|
DOCASSEMBLE_DEVELOPER_API_KEY: "${{ steps.github_server.outputs.DOCASSEMBLE_DEVELOPER_API_KEY }}"
|
|
159
159
|
INSTALL_METHOD: "server"
|
|
160
|
-
|
|
160
|
+
_ALKILN_INTERNAL_TESTS: "true"
|
|
161
|
+
#### Developer note: You can probably leave the rest out
|
|
161
162
|
#### To learn more, see https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
|
|
162
163
|
ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
|
|
163
|
-
|
|
164
|
-
ALKILN_VERSION: "action_outputs"
|
|
165
|
-
|
|
166
|
-
#### Developer note: You can leave out this section
|
|
167
|
-
# Test our own action output
|
|
168
|
-
- shell: bash
|
|
169
|
-
if: ${{ always() }}
|
|
170
|
-
env:
|
|
171
|
-
GH_TOKEN: ${{ github.token }}
|
|
172
|
-
PATH_TO_ARTIFACTS: "${{ steps.alkiln.outputs.PATH_TO_ARTIFACTS }}"
|
|
173
|
-
PATH_TO_REPORT_FILE: "${{ steps.alkiln.outputs.PATH_TO_REPORT_FILE }}"
|
|
174
|
-
PATH_TO_REPORT_LOG_FILE: "${{ steps.alkiln.outputs.PATH_TO_REPORT_LOG_FILE }}"
|
|
175
|
-
PATH_TO_UNEXPECTED_RESULTS_FILE: "${{ steps.alkiln.outputs.PATH_TO_UNEXPECTED_RESULTS_FILE }}"
|
|
176
|
-
PATH_TO_DEBUG_LOG_FILE: "${{ steps.alkiln.outputs.PATH_TO_DEBUG_LOG_FILE }}"
|
|
177
|
-
run: |
|
|
178
|
-
echo "PATH_TO_ARTIFACTS: $PATH_TO_ARTIFACTS"
|
|
179
|
-
echo "PATH_TO_REPORT_FILE: $PATH_TO_REPORT_FILE"
|
|
180
|
-
echo "PATH_TO_REPORT_LOG_FILE: $PATH_TO_REPORT_LOG_FILE"
|
|
181
|
-
echo "PATH_TO_UNEXPECTED_RESULTS_FILE: $PATH_TO_UNEXPECTED_RESULTS_FILE"
|
|
182
|
-
echo "PATH_TO_DEBUG_LOG_FILE: $PATH_TO_DEBUG_LOG_FILE"
|
|
183
|
-
|
|
184
|
-
# Test accessing the report file
|
|
185
|
-
if [ -f "${{ env.PATH_TO_REPORT_FILE }}" ]; then
|
|
186
|
-
REPORT_TEXT=$(cat "${{ env.PATH_TO_REPORT_FILE }}")
|
|
187
|
-
echo "The report file exists and we can get its text"
|
|
188
|
-
else
|
|
189
|
-
echo "The report file does not exist. Something other than the interview tests may have failed."
|
|
190
|
-
fi
|
|
164
|
+
ALKILN_VERSION: action_outputs
|
|
191
165
|
|
|
192
166
|
#### Developer note: Example of making an issue when tests fail
|
|
193
167
|
#### that includes the text of the failure output file
|
|
@@ -203,13 +177,13 @@ jobs:
|
|
|
203
177
|
# Make an issue with file contents or 'no file' message as part of the body
|
|
204
178
|
|
|
205
179
|
if [ -f "${{ env.PATH_TO_UNEXPECTED_RESULTS_FILE }}" ]; then
|
|
206
|
-
|
|
180
|
+
UNEXPECTED_2=$(cat "${{ env.PATH_TO_UNEXPECTED_RESULTS_FILE }}")
|
|
207
181
|
else
|
|
208
|
-
|
|
182
|
+
UNEXPECTED_2="unexpected_results.txt does not exist. Something other than the interview tests may have failed."
|
|
209
183
|
fi
|
|
210
184
|
|
|
211
185
|
gh issue create --body "An ALKiln test run failed. See the action at ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}.
|
|
212
186
|
|
|
213
187
|
### Results:
|
|
214
188
|
|
|
215
|
-
$
|
|
189
|
+
$UNEXPECTED_2" --repo "$GITHUB_REPOSITORY" --label "testing" --title "ALKiln tests failed"
|
|
@@ -33,7 +33,7 @@ jobs:
|
|
|
33
33
|
|
|
34
34
|
env:
|
|
35
35
|
#### Developer note: We recommend turning these into environment
|
|
36
|
-
#### variables
|
|
36
|
+
#### variables before using them as inputs later
|
|
37
37
|
SERVER_URL: ${{ secrets.SERVER_URL }}
|
|
38
38
|
DOCASSEMBLE_DEVELOPER_API_KEY: ${{ secrets.DOCASSEMBLE_DEVELOPER_API_KEY }}
|
|
39
39
|
|
|
@@ -75,13 +75,13 @@ jobs:
|
|
|
75
75
|
#### https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#githubNyou-inputs
|
|
76
76
|
SERVER_URL: "${{ env.SERVER_URL }}"
|
|
77
77
|
DOCASSEMBLE_DEVELOPER_API_KEY: "${{ env.DOCASSEMBLE_DEVELOPER_API_KEY }}"
|
|
78
|
+
_ALKILN_INTERNAL_TESTS: "true"
|
|
78
79
|
#### Developer note: See https://assemblyline.suffolklitlab.org/docs/alkiln/writing/#optional-inputs
|
|
79
80
|
#### You can probably leave this out
|
|
80
81
|
ALKILN_MAX_RANDOM_TESTS_PER_SCENARIO: 10
|
|
81
82
|
# Internal: docassemble changes sometimes break @a11y tests. That is
|
|
82
|
-
# a da problem, not ours. We
|
|
83
|
+
# a da problem, not ours. We will trigger these tests manually when we
|
|
83
84
|
# want to check up on this.
|
|
84
|
-
#### Developer note: Optional inputs. You can probably leave the rest out
|
|
85
85
|
ALKILN_TAG_EXPRESSION: "${{ env.ALKILN_TAG_EXPRESSION }}"
|
|
86
|
-
|
|
87
|
-
ALKILN_VERSION:
|
|
86
|
+
#### Developer note: You can probably leave this out
|
|
87
|
+
ALKILN_VERSION: action_outputs
|
package/CHANGELOG.md
CHANGED
|
@@ -45,17 +45,21 @@ Format:
|
|
|
45
45
|
|
|
46
46
|
## [Unreleased]
|
|
47
47
|
|
|
48
|
-
### Added
|
|
49
|
-
|
|
50
|
-
- Added `_ALKILN_INTERNAL_TESTS` action.yml input to allow us to skip some security flags to install and test our development releases of ALKiln.
|
|
51
|
-
|
|
52
48
|
### Changed
|
|
53
49
|
|
|
54
|
-
- In action.yml,
|
|
50
|
+
- In action.yml, replaced `npm rebuild` with an explicit search for existing puppeteer chrome executables. There is no fallback if all of those are missing. Addresses [#1088](https://github.com/suffolkLITLab/aLKiln/issues/1088). We hope to address the core issue when we can.
|
|
55
51
|
|
|
56
52
|
### Fixed
|
|
57
|
-
- Artifacts were being created in the wrong dir when using the main action.yml in GitHub actions. See [#1055](https://github.com/suffolkLITLab/aLKiln/issues/1055). We will have to release a temporary fix in the action to let people run passing tests until the week is up and the fix passes our new security measures.
|
|
58
53
|
|
|
54
|
+
- Restore custom artifacts path argument to allow environments like action.yml to make and reuse their own artifacts path value in environments where it's hard to pass around return values. Closes [#1055](https://github.com/suffolkLITLab/aLKiln/issues/1055).
|
|
55
|
+
|
|
56
|
+
### Security
|
|
57
|
+
|
|
58
|
+
- Moved responsibility for security measures to ALKiln internal development by automating internal security measures with `.npmrc`. Closes [#1088](https://github.com/suffolkLITLab/aLKiln/issues/1088).
|
|
59
|
+
|
|
60
|
+
### Internal
|
|
61
|
+
|
|
62
|
+
- Avoid testing on our dev server with every push, uses cron job instead.
|
|
59
63
|
|
|
60
64
|
## [5.16.0] - 2026-05-14
|
|
61
65
|
|
package/action.yml
CHANGED
|
@@ -14,7 +14,7 @@ inputs:
|
|
|
14
14
|
ALKILN_VERSION:
|
|
15
15
|
description: 'Version of ALKiln to get from npm.'
|
|
16
16
|
required: false
|
|
17
|
-
default: '
|
|
17
|
+
default: '5.15.4'
|
|
18
18
|
MAX_SECONDS_FOR_SETUP:
|
|
19
19
|
description: "Amount of time to give the Project to upload your package's GitHub code."
|
|
20
20
|
required: false
|
|
@@ -37,11 +37,6 @@ inputs:
|
|
|
37
37
|
description: "The maximum number of tests ALKiln will generate for every Scenario that can generate tests."
|
|
38
38
|
required: false
|
|
39
39
|
# Default will be internal to avoid duplication of data
|
|
40
|
-
_ALKILN_INTERNAL_TESTS:
|
|
41
|
-
description: "If true, will use different security settings."
|
|
42
|
-
type: boolean
|
|
43
|
-
required: false
|
|
44
|
-
default: false
|
|
45
40
|
|
|
46
41
|
outputs:
|
|
47
42
|
PATH_TO_ARTIFACTS:
|
|
@@ -121,43 +116,13 @@ runs:
|
|
|
121
116
|
node-version: "24.x"
|
|
122
117
|
package-manager-cache: false
|
|
123
118
|
|
|
124
|
-
|
|
125
|
-
- name: "💡 ALK0026 INFO: Install ALKiln directly from npm (at least 7 days old)"
|
|
126
|
-
if: ${{ inputs._ALKILN_INTERNAL_TESTS != true }}
|
|
119
|
+
- name: "💡 ALK0026 INFO: Install ALKiln directly from npm"
|
|
127
120
|
shell: bash
|
|
128
121
|
run: |
|
|
129
122
|
log="💡 ALK0026 INFO: Install ALKiln directly from npm"
|
|
130
|
-
repo_name="${{ github.event.repository.name }}"
|
|
131
|
-
if [[ $repo_name == *"ALKiln"* ]]; then
|
|
132
|
-
echo "⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️ YOU MAY BE MISSING THE _ALKILN_INTERNAL_TESTS FLAG ⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️"
|
|
133
|
-
fi
|
|
134
123
|
echo -e "\n$log" >> "${{ env.DEBUG_PATH }}"
|
|
135
|
-
|
|
136
|
-
echo "⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️"
|
|
137
|
-
fi
|
|
138
|
-
npm install --ignore-scripts --min-release-age=7 -g "@suffolklitlab/alkiln@$ALKILN_VERSION"
|
|
124
|
+
npm install -g "@suffolklitlab/alkiln@$ALKILN_VERSION"
|
|
139
125
|
|
|
140
|
-
# For internal development, allow testing with more recent versions of ALKiln
|
|
141
|
-
- name: "🔎 ALK0279 WARNING: Install recent version of ALKiln directly from npm"
|
|
142
|
-
if: ${{ inputs._ALKILN_INTERNAL_TESTS == true }}
|
|
143
|
-
shell: bash
|
|
144
|
-
run: |
|
|
145
|
-
log="🔎 ALK0279 WARNING: Install **recent** version of ALKiln directly from npm"
|
|
146
|
-
repo_name="${{ github.event.repository.name }}"
|
|
147
|
-
if [[ $repo_name != *"ALKiln"* ]]; then
|
|
148
|
-
echo "⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️ YOU MAY BE USING AN UNSAFE VERSION OF ALKILN ⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️"
|
|
149
|
-
fi
|
|
150
|
-
echo -e "\n$log" >> "${{ env.DEBUG_PATH }}"
|
|
151
|
-
if [[ $repo_name != *"ALKiln"* ]]; then
|
|
152
|
-
echo "⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️"
|
|
153
|
-
fi
|
|
154
|
-
npm install --ignore-scripts -g "@suffolklitlab/alkiln@$ALKILN_VERSION"
|
|
155
|
-
|
|
156
|
-
# Install puppeteer browser that we skipped with security feature --ignore-scripts
|
|
157
|
-
- name: "💡 ALK0280 INFO: Install puppeteer browser that we skipped with security feature --ignore-scripts"
|
|
158
|
-
if: ${{ inputs._ALKILN_INTERNAL_TESTS == true }}
|
|
159
|
-
shell: bash
|
|
160
|
-
run: |
|
|
161
126
|
BROWSER="$(
|
|
162
127
|
command -v google-chrome-stable ||
|
|
163
128
|
command -v google-chrome ||
|
|
@@ -167,10 +132,12 @@ runs:
|
|
|
167
132
|
true
|
|
168
133
|
)"
|
|
169
134
|
if [[ -n "$BROWSER" ]]; then
|
|
170
|
-
|
|
135
|
+
log_result="💡 ALK0279 INFO: Found puppeteer browser executable at '$BROWSER'"
|
|
136
|
+
echo -e "\n$log_result" >> "${{ env.DEBUG_PATH }}" && echo -e "$log_result"
|
|
171
137
|
echo "PUPPETEER_EXECUTABLE_PATH=$BROWSER" >> "$GITHUB_ENV"
|
|
172
138
|
else
|
|
173
|
-
|
|
139
|
+
log_result="🤕 ALK0280 INFO: Unable to find puppeteer browser executable"
|
|
140
|
+
echo -e "\n$log_result" >> "${{ env.DEBUG_PATH }}" && echo -e "$log_result"
|
|
174
141
|
# Our project uses bash error codes in the 50's. This may change.
|
|
175
142
|
exit 51
|
|
176
143
|
fi
|
package/package.json
CHANGED