Skip to content

Changelog

Notable changes to rn-forge-commons, newest first, in the Keep a Changelog format.

[Unreleased]

[0.10.1] - 2026-11-20

Added

  • ArtifactKind.KEYS, with Artifact.keys and StateEntry.key_paths: the generator owns named key paths in a JSON or TOML file. diff takes an optional entries keyword.
  • DocumentUtils.serialize_document, the text write_document would write.

Changed

  • The testing extra requires assertpy>=2.36.0.

[0.10.0] - 2026-11-17

Changed

  • File digests no longer read the whole file into memory.
  • TaskPool.submit counts duplicate names in one pass.
  • DictUtils.merge copies override values only when assigning them.
  • AppLogger no longer replaces the process record factory; its own records format braces over any factory.
  • ApplyResult.written reports each write path once in plan order and no longer lists unchanged, skipped, forgotten or dry-run paths.

Fixed

  • Configuring the logger no longer logs a NOTICE; it is DEBUG now. A plain-format timestamp shows its milliseconds once.
  • AppLogger level methods report the caller's file, line and function.

[0.9.0] - 2026-11-13

Added

  • Log redaction in rn_forge.commons.logging.redaction: redact, RedactionPolicy and REDACTED, exported from rn_forge.commons. A value under a key whose final segment is authorization, cookie, password, secret or token is replaced, and Bearer/Basic credentials and scheme://user:password@host passwords are scrubbed from any string.
  • RedactFilter (exported from rn_forge.commons) applies redaction to a record's message, args and extra fields on every AppLogger handler. LoggingConfig.redact and AppLogger.initialize(redact=...) control it.
  • redact_processor in rn_forge.commons.logging.structlog redacts structlog events before they are rendered.
  • PathUtils.atomic_replace: a context manager that yields a temporary sibling of a file, then publishes it over the file atomically; atomic_write is now built on it.
  • PathUtils.move_no_clobber: moves a file without ever overwriting the destination, including across filesystems.
  • PathUtils.prune_empty_parents: removes a directory and its empty ancestors up to, but never including, a stop directory.
  • ThreadActor in rn_forge.commons.runtime.actor: builds a resource on a dedicated owner thread and runs every call against it there, through submit (a Future) or run (awaitable).
  • TaskPool.map_settled runs a function over items on the pool and returns a Succeeded or Failed per item in input order; Succeeded, Failed and Settled are exported from rn_forge.commons.
  • ManagedBlock.end_indent: leading whitespace of the end marker alone, for a block whose body is indented but whose end marker sits at a different indent. None (the default) uses indent, so existing blocks render the same bytes.

Changed

  • output_path now writes under .tmp/<scope>/tests/output/ instead of .out/. Breaking: consumers that read or ignore .out/ must use .tmp/.
  • Log redaction is on by default, so secrets logged in messages, arguments or extra fields now appear as [redacted]. Pass redact=False to AppLogger.initialize to keep the old output. Exception tracebacks are not redacted.
  • MarkdownUtils parses a document once and shares the result across headings, anchors, title, links, tables and strip_fenced_code, through a process-local cache of at most 2048 documents keyed by text. The API and its results are unchanged.

[0.8.1] - 2026-10-30

Changed

  • Files on PyPI carry PEP 740 attestations. There is no code change.

[0.8.0] - 2026-10-29

Changed

  • The package declares the MIT licence and is published to PyPI.

Removed

  • Breaking: rn_forge.commons.integration.auth and the auth extra. JwtVerifier, discover_oidc, fetch_json, FetchJson, OidcConfiguration and TokenVerificationError moved to rn_forge.auth.oidc in rn-forge-auth; JwksCache is deleted in favour of PyJWT's PyJWKClient.

[0.7.0] - 2026-10-25

Added

  • DocumentUtils.read of a package resource; header and multiline_arrays on dumps and write; DocumentUtils.multiline_arrays; DictUtils.as_mapping, ListUtils.as_list and ListUtils.as_strings.
  • rn_forge.commons.generation, moved from rn-forge-tooling.
  • StateStore (rn_forge.commons.fs.state), moved from rn-forge-tooling.
  • rn_forge.commons.text.templates, moved from rn-forge-tooling, with autoescape and TemplateEngine.cached.
  • The templates extra.
  • rn_forge.commons.text.markdown (MarkdownUtils, MarkdownHeading, MarkdownTable) and the markdown extra.
  • TemplateArtifact and render_artifacts in rn_forge.commons.generation.templated (extra templates).
  • diff and disk_content in rn_forge.commons.generation.

Changed

  • Plain YAML loads use libyaml (ruamel.yaml[oldlibyaml]); plain TOML reads use tomllib; DocumentUtils.read names the file in a parse error.
  • Breaking: DocumentUtils.read treats a path that exists but is not a file as missing.

Fixed

  • A parser message containing a brace now raises DocumentError.
  • A Jinja error whose message contains a brace now raises RenderError.

[0.6.0] - 2026-10-16

Removed

  • Breaking: rn_forge.commons.data.excel and rn_forge.commons.data.pandas, and the pandas aliases SeriesRow, series_value and series_columns in rn_forge.commons.lang.types. They moved to rn-forge-data, with the same class names; import them from rn_forge.data and rn_forge.data.pandas.
  • Breaking: the excel and pandas extras. Depend on rn-forge-data, or rn-forge-data[pandas], instead.

[0.5.0] - 2026-09-27

Released with pykit's first coordinated set of tags (release-1).

rn-forge-commons-v0.1.0 to rn-forge-commons-v0.2.2 predate this file; their notes are on the GitHub Releases page.