Skip to content

Commit b0592ab

Browse files
authored
chore: add upgrading advice for 10.0.0
1 parent 3c9974f commit b0592ab

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

UPGRADING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
This document describes breaking changes and how to upgrade. For a complete list of changes including minor and patch releases, please refer to the [changelog](./CHANGELOG.md).
44

5+
## 10.0.0
6+
7+
### Configuration files
8+
9+
Configuration files must now be one of our supported extensions (`.json`, `.yaml`, `.yml`, `.cjs`, `.js`, `.mjs`). JavaScript files are now loaded with the appropriate mechanism based on the file extension and package type. If you previously relied on our internal usage of `require()` to dynamically transpile, you'll instead need to transpile beforehand and point Cucumber at the transpiled output.
10+
11+
### Module loading
12+
13+
Custom formatters and snippet syntaxes are now always loaded with `await import()`. If you previously relied on our internal usage of `require()` to dynamically transpile, you'll instead need to transpile beforehand and point Cucumber at the transpiled output.
14+
15+
If no support code is specified with either the `import` or `require` options, we'll now load files from the default paths with `await import()`. If you need the use of `require()` for your setup to work, you'll need to use that option explicitly.
16+
17+
### Attachments in JSON formatter
18+
19+
Previously, string attachments were included as plain text in the JSON formatter output, where other attachments were Base64 encoded. This meant for consumers, it was ambiguous whether any attachment was Base64 encoded or not. Now, all attachments are Base64 encoded regardless of how they were initially attached.
20+
521
## 9.0.0
622

723
### Generator snippet interface

0 commit comments

Comments
 (0)