Release Notes

Bugfixes

• Fix a folder boundary bug
  If you had a step that works on the “art” folder and a second step that works on the “articles” folder, the first step would also claim all articles.

Documentation Changes

• Improve documentation

Bugfixes

• Revert sequence and publicationDateInFilename back to free functions
  Release 2.25.0 moved sequence and publicationDateInFilename to the Saga namespace, but it turns out this is not nice when you combine this with your own item processors and/or SagaUtils. I’ve now reverted this change. Sorry if you already upgraded to 2.25.0 earlier today!

New Features

• Migrate 5 global functions and one global variable to the Saga namespace
• Add built-in support for the slug frontmatter property

New Features

• Add support for sitemaps (#45 by kevinrenskers)
• Item title should fallback to frontmatter’s title, and only then to the filename
• Nested processing steps (#46 by kevinrenskers)
• Add a caching mechanism for fetched items

Documentation Changes

• Add new how-to guides

New Features

• Simplify logic and speed up the write step on sites with lots of files (#43 by kevinrenskers)

Simplifies Saga’s internal architecture by removing four internal types (FileContainer, ProcessStep<M>, AnyProcessStep, ItemBox<M>) and replacing them with simpler data structures.

• File tracking: FileContainer class replaced by a tuple array [(path: Path, relativePath: Path)] with a Set<Path> for handled state and a [String: String] dict for content hashes.
• Pipeline steps: Type-erased wrapper classes replaced by closure pairs (read: ReadStep, write: WriteStep) stored directly on Saga.
• Writer context: Writer.run now takes a WriterContext<M> struct instead of 6 individual parameters.
• Resource lookup: Per-item linear scan of all files replaced by a precomputed dictionary, resulting in a ~2.5x faster write phase on file-heavy sites (it saves 0.5 seconds on loopwerk.io).
• Added a new convenience groupedWriter, a version of partitionedWriter that takes a key path. yearWriter now uses it under the hood.

The public API is unchanged.

New Features

• Add @preconcurrency to silence warnings for Swift 5.10 users

New Features

• Moved to Swift 6
  • Solved the SendableMetatype warnings for Swift 6 projects.
  • Add Sendable conformances and @Sendable annotations throughout.
  • While Saga now uses the Swift 6 toolchain, backwards compatibility with Swift 5 projects is maintained.
  • Users still on Swift 5 will most likely get warnings about “Converting non-Sendable function value to @Sendable”. This is unfortunate, but it’s not feasible to make Saga compatible and crash-free with Swift 6 while also not introducing these warnings for Swift 5 users. Please upgrade your Package.swift to use swift-tools-version:6.0.

New Features

• Add @Sendable annotations and refactor postProcess/reader pipeline
  Refactor postProcess to use a postProcessors array, fixing createPage not applying post-processors.

New Features

• Switched from kylef/PathKit to loopwerk/PathKit
  The original project seems unmaintained. My fork updated the minimum Swift version to 5.10, added Swift 6 support with Sendable, added Decodable support, and fixed all the unit tests (they didn’t run at all).

Improvements

• Full support for Swift 6

Changes

• Updated the minimum Swift version to 5.10

Bugfixes

• Restored Swift 5.10 compatibility
• Fixed all compiler warnings, both when running in Swift 5 and when using it in a Swift 6 project
• Pin swift-asn1 to 1.4.x for Swift 5 compatiblity

Notes

• Releases 2.18.1 to 2.18.8 were removed since they all fixed the same issues

New Features

• Added an itemProcessor property to the register(fetch) method

New Features

• Removed the Saga CLI from this package, and into its own repository
  This should make dependency resolution quicker for Saga users, pulling in fewer dependencies.

Bugfixes

• Fixed the date formatting as part of the printed log messages
• Only depend on swift-crypto when building on Linux; on macOS, the system CryptoKit framework is used (zero compile time)

New Features

• Add postProcess step for transforming written output
• Add isDev flag, set SAGA_DEV in dev and watch commands
• Add hashed() for cache-busting asset URLs

Renames

• Renamed filteredOutItemsAreHandled to claimExcludedItems. The old version has been marked as deprecated and will be removed in the next major version.

Bugfixes

• Copy the static files before running the write phase, so that we’re sure the static folders exist for use during custom register steps

New Features

• Make it natural to create fully custom register steps (#42 by kevinrenskers)

New Features

• Programmatic pages (#41 by kevinrenskers)
• Static files are automatically copied as part of the run function, the staticFiles method is now deprecated

New Features

• Items can now be loaded programmatically (#40 by kevinrenskers)

Documentation Changes

• Example app has a new page showing how to programmatically load content from an API
• Added proper documentation for the nested subfolder processing feaure

New Features

• A brand new saga CLI with init, dev and build commands, installable via Homebrew and Mint (#39 by kevinrenskers)

New Features

• Make it possible to override the item sorting (closes #37)
• Support nested subfolder processing as separate steps by using a glob syntax (foldername/**)
• Add previous/next properties to ItemRenderingContext (closes #36)

Documentation Changes

• Big README rewrite
• Massively improved Example app with a new design and much nicer photo albums, that now also show a page per photo
• Added Moon to the example project to show server-side syntax highlighting with Prism

New Features

• Add support to the Atom feed writer for article images via <media:content>

Bugfixes

• The file change watcher now ignores .DS_Store files

Bugfixes

• Fix running tests on Linux

New Features

• Much improved file watcher logic and watch command arguments

You can now run it like this:

$ swift run watch --watch content --watch Sources --ignore input.css --output deploy

New Features

• Added an explicit created property to Item

New Features

• Make it possible to supply a dateKeyPath for the Atom feed, which determines how theelement gets its value

New Features

• Added a new filteredOutItemsAreHandled option

New Features

• Renderers can now optionally be async

Documentation Changes

• Docs are now automatically generated via a GH Action and don’t need to live in the main branch any longer

Tests

• Fix flaky tests in CI
• Make Reader.convert public so that plugins can use this to write unit tests

New Features

• Parallelize Saga (#34 by kevinrenskers)

Bugfixes

• Saga is now compatible with Swift 5.5 as well as Swift 6

New Features

• Improve the atom feed writer, always include the full body text

Bugfixes

• Always add the link element to entries when generating the Atom feed

Tests

• Add testDateFromFrontMatter

Bugfixes

• Restore Saga 1.x behavior where the item title defaults to the file name (without the extension)

New Features

• Make some Path extensions public instead of internal

Bugfixes

• There is no reason for Reader to have the generic type M any longer

Bugfixes

• Go back to XMLElement instead of string interpolation for the atom feed generation, but in a way that works on Linux

Bugfixes

• Fix linux compatibility (#25)

Tests

• Fix tests

New Features

• Include an Atom feed helper function with Saga itself (#23)
• Get rid of the Codextended dependency
• Clean up Item dates (#22)