@suffolklitlab/alkiln 5.0.0-pre-4 → 5.0.0-pre-5

package/CHANGELOG.md

@@ -45,6 +45,7 @@ Format:
   be run in any directory, not just in an npm package.
 - Additional environment variables and their validation to allow for tests that run on a developer's server/Playground instead of through GitHub. Also, other functionality for that purpose. [Issue #661](https://github.com/SuffolkLITLab/ALKiln/issues/661)
 - Tests for new session_vars behavior and improve previous tests.
+- Adds `npm-shrinkwrap.json`, so installs from npm will have fixed version dependencies
 
 ### Changed
 - upgraded cucumber v8.6.0

package/CONTRIBUTING.md

@@ -112,6 +112,12 @@ Our tests require the user/developer to have a docassemble server on which they
 
 When the developer commits code to GitHub, their account triggers our code, passing along variables that our code needs, like their GitHub secret of the API key for their docassemble server developer account.
 
+## Updating dependencies
+
+Sometimes you will have to add dependencies to ALKiln. You can do so by adding the dependency in the `package.json` "dependencies" section, specifying an exact version. Then, run `npm install` to update `npm-shrinkwrap.json` to have the new dependency.
+
+If you have to update an existing dependency, you can change the version in `package.json`, and run `npm install` to update `npm-shrankwrap.json`.
+
 ## Very general architecture of files and folders
 
 An honest look at our current project architecture—some of our files and folders, what they do, and how they interact.

package/lib/scope.js

@@ -285,7 +285,8 @@ module.exports = {
   getJSONFilename: async function( scope ) {
     // Get a unique path for a json file
     let { id } = await scope.examinePageID( scope, 'none to match' );
-    let json_path = path.join( scope.paths.scenario, `json_for-${ id }-${ Date.now() }.json` );
+    let short_id = `${ id }`.substring(0, 20);
+    let json_path = path.join( scope.paths.scenario, `json_for-${ short_id }-${ Date.now() }.json` );
     return json_path;
   },