diff options
Diffstat (limited to 'NEWS.md')
| -rw-r--r-- | NEWS.md | 98 |
1 files changed, 98 insertions, 0 deletions
@@ -4,6 +4,104 @@ This file summarises the changes between released versions of Subplot and its associated libraries, especially with regards to changes visible to the user of the Subplot software. +# Version UNRELEASED + +- Subplot's MSRV has been updated to 1.70 in line with Debian testing. + +# Version 0.9.0, released 2023-08-27 + +- We hope this will be the last breaking change before 1.0, however we + are not ruling out future breaks if they are justified to improve + usability or capability before an official 1.0 release +- We now pass a lot more meta-information about step location to the + templates for building test suites. + +# Version 0.8.0, released 2023-06-14 + +- Subplot now permits multiple markdown documents to be used in a single + subplot document. +- Indented scenario statements, while permitted before, were never meant + to be part of the spec, they are now considered an error in case we + wish to use the semantics of indentation later. + +# Version 0.7.1, released 2023-04-30 + +- Subplot now handles scenario titles with markup (such as bold face). + This was broken in the changes to drop use of Pandoc for parsing. +- CI job using the MSRV version doesn't check source code formatting + anymore. +- The dependency on the roadmap crate now depends on a version that + doesn't require the `clap` crate at all anymore. + +# Version 0.7.0, released 2023-04-10 + +- Subplot no longer uses `pandoc` at all. This means that + output is currently limited to HTML only, and the formatting + of that HTML has changed, however this is the first step + along the path of being significantly easier to use long-term. +- Subplot's MSRV has been updated to 1.63 and our plan is to + maintain an MSRV of whatever is in Debian's `testing` distribution + until Subplot is in Debian. +- We have updated our crates to the 2021 edition of Rust. This should + not affect anyone since the 2021 edition has been supported since + 1.56 of Rust. + +# Version 0.6.0, released 2022-11-13 + +- Subplot metadata now expects `authors` rather than `author` + to support multiple authors for documents. This is a breaking + change, hence the semver bump. +- Subplot metadata now supports a `pandoc` mapping at the top level + which provides metadata to be inserted into the Pandoc document + build when producing PDFs or HTML. +- There is now a `path` type, to go alongside `text` `word` etc. + Paths are expected to be (parts of) paths on the filesystem and + we have updated all bindings to use `path` where sensible to do so. +- Subplotlib steps now handle the `path` type as `&Path`, so steps which + expect to be given paths should use that, rather than `&str`. + +# Version 0.5.0, released 2022-09-13 + +- The big, breaking change for this release is that Subplot now + expects document metadata in a separate YAML file. It was previously + embedded in the Markdown input file. This allows us to be more + strict, when parsing the metadata: we only need to support what + Subplot needs, not the nearly arbitrary YAML Pandoc supports. Later + on, it will also enable us to support multiple Markdown files as + input. + +- That change also means that we drop support for use of Subplot as a + Pandoc filter (the `subplot-filter` command and the `subplot filter` + subcommand). It doesn't make sense unless the metadata is + embedded in the Markdown. + +- We've renamed things so that we consistently call a Markdown fenced + code block that is marked as a data file, an "embedded file". + Previously we also used other names, causing unnecessary confusion. + +- The new home page URL is updated in all crate metadata. This means + crates.io will point at the new location after this release is made. + +# Version 0.4.3, released 2022-007-29 + +- Bump the dependency on the `roadmap` crate to a version that depends + on `clap` version 3 to that it doesn't drag in `structopt`. + +# Version 0.4.2, released 2022-007-28 + +- New feature: Subplot now supports example blocks: embedded files + that are in the subplot document only as examples, not for use by + scenarios. + +- Subplot error messages are now a little bit more specific as to the + cause, and what operation failed. + +- Subplot now uses the `time` crate instead of the `chrono` crate to + avoid a potential security issue. + +- Terminology change: we now refer to diagrams as diagrams, not + graphs. + # Version 0.4.1 (subplotlib only), released 2022-04-17 - Fix issue where subplotlib cannot be built out-of-tree |