@suffolklitlab/alkiln 5.8.1 → 5.9.0

package/.github/workflows/github_server.yml

@@ -3,7 +3,7 @@ name: GitHub server installation
 on:
   push:
   # Default "opened", "reopened", "synchronize". "edited" fires when the PR title gets edited, etc.
-  pull_request_target:
+  pull_request:
   workflow_dispatch:
     inputs:
       tags:
@@ -42,13 +42,14 @@ jobs:
 
       - name: ALKiln - Start the isolated temporary docassemble server on GitHub
         id: github_server
-        #### Developer note: you'll need to replace `.` with the path to
-        #### the repo and branch. For example:
+        #### Developer note: you'll need to replace `.` with the path to ALKiln’s
+        #### repo and branch. For example, for version 5, put
         #### suffolkLITLab/ALKiln/action_for_github_server@v5
+        #### Come back and update this version later if you want the latest
         uses: ./action_for_github_server
         with:
           CONFIG_CONTENTS: "${{ secrets.CONFIG_CONTENTS }}"
-          #### Developer note: Set this to True to show docker logs and
+          #### 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 }}"
       - run: echo "ALKiln finished starting the isolated GitHub docassemble server"
@@ -77,9 +78,10 @@ jobs:
 
       - name: "Run ALKiln tests"
         if: ${{ success() }}
-        #### Developer note: you'll need to replace `.` with the path to
-        #### the repo and branch and leave off the trailing `/`
-        #### For example suffolkLITLab/ALKiln@v5
+        #### Developer note: you'll need to replace `.` with the path to ALKiln’s
+        #### repo and branch and leave off the trailing `/`
+        #### For example, for version 5 put suffolkLITLab/ALKiln@v5
+        #### Come back and update this version later if you want the latest
         uses: ./
         with:
           SERVER_URL: "${{ steps.github_server.outputs.SERVER_URL }}"
@@ -87,5 +89,7 @@ jobs:
           INSTALL_METHOD: "server"
           #### Developer note: Useful for temporarily shortening ALKiln tests
           #### to debug the docker install step
+          #### Use a "tag expression" to specify which tagged tests to run (https://cucumber.io/docs/cucumber/api/#tag-expressions)
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
+          # ALKILN_VERSION: 2column
 

package/.github/workflows/playground.yml

@@ -3,7 +3,7 @@ name: Playground installation
 on:
   push:
   # Default: opened, reopened, synchronize. "edited" is not what we want.
-  pull_request_target:
+  pull_request:
   workflow_dispatch:
     inputs:
       tags:
@@ -55,4 +55,4 @@ jobs:
           #### to debug the docker install step
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
           #### Developer note: you probalby don't need this
-          # ALKILN_VERSION: 5.7.0-feature-tap1
+          # ALKILN_VERSION: 2column

package/CHANGELOG.md

@@ -45,6 +45,23 @@ Format:
 
 <!-- ## [Unreleased] -->
 
+## [5.9.0] - 2024-02-11
+
+### Added
+
+- New feature: 2-column Story Tables that work without the trigger variable. Now column 1, "var", should only contain the actual variable name with no proxies (x, i, j, etc). For example, instead of `x[i].name.first` the var column should now contain `users[0].name.first`. Column 2 is the same as it was before - the answer for the field. See [#582](https://github.com/SuffolkLITLab/ALKiln/issues/582).
+- Added console logs enhancing the "progress dots". You don't usually see those till after the tests run. Now more of them should show up during the test run and the name of the Scenario being tested should appear there as well. Unfortunately, the first Scenario behaves differently. We're consulting with the creators of cucumber to understand why that's happening.
+
+### Changed
+- Reduced a couple error messages. See [#573](https://github.com/SuffolkLITLab/ALKiln/issues/573) and [#452](https://github.com/SuffolkLITLab/ALKiln/issues/452).
+
+### Internal
+- Internal tests: Fixed Scenarios that had failed but had correct reports were instead passing.
+- Internal tests: Allow more types of "expected status" for when we test dealing with "undefined", "skipped", etc.
+- Internal tests: Changed name suffix values in tests. Assembly Line changed its punctuation a while ago.
+- Added doc explaining what internal test results we expect to see as people new to the project are surprised by all our red Fs and yet passing tests.
+- Changed our workflow's `on: pull_request_target` to `on: pull_request`. When the former runs tests, `checkout` checks out the target branch's files. It was unhelpful to test the files of the old branch with the new version of ALKiln. The latter checks out the head branch's files. We should be good now.
+
 ## [5.8.1] - 2023-12-28
 
 ### Fixed

package/docs/expected_inernal_results.md

@@ -0,0 +1,15 @@
+# What results are we expecting in our own tests?
+
+Our internal test results look a little strange. For example, they sometimes initially look like they're failing, but eventually pass. That's because we're testing that our tests respond appropriately to authors' failures as well as successees.
+
+These are the results that we expect:
+
+## Cucumber feature tests {#cucumber}
+
+- Many red `F`s in our cucumber "progress bar"
+- Final results to show all Scenarios passing
+- Cucumber seems to be unable to print the name of the first scenario
+
+## Unit tests {#unit}
+
+All these must pass