What’s New in Antora 3.1

Antora 3.1.1

Release date: 2022.09.21 | Issue label: 3.1.1

Resolved issues

Changed

Issue #1004

Use pretty log format by default if IS_TTY environment variable is set to true. Print success message if IS_TTY environment variable is set to true. See Log Format for more information.

Fixed

Issue #1003

Prevent message from ignored log message from overwriting message from next reported log message.

Update to Issue #984

Define public export @antora/asciidoc-loader/include/resolve-include-file for requiring resolveIncludeFile function.

Site generator

Don’t require custom output provider to return a report object.

CLI

If logger can’t be found, print error message to stderr instead of crashing during shutdown.

Antora 3.1.0

Release date: 2022.08.22 | Issue label: 3.1.0

The highlights of the Antora 3.1.0 release include:

You can find a summary of the issues resolved in this release below.

Resolved issues

Added

Issue #221

Log info message if no references are found for content source.

Issue #354

Assign edit URL of current page, if set, to page-edit-url AsciiDoc attribute. Define boolean page-origin-private AsciiDoc attribute if origin of page is private.

Issue #525

Attach parsed component version descriptor to descriptor property on origin object.

Issue #814

Add removeFile method to the content catalog and UI catalog.

Issue #921

Define page-component-latest-version AsciiDoc attribute with value of version string from latest component version. Define boolean page-component-version-is-latest AsciiDoc attribute if page is in latest version of component. See intrinsic page attributes for more information.

Issue #978

Add origins property containing unique origin objects to each entry in the content aggregate.

Issue #981

Resolve attribute references in AsciiDoc attributes defined in the playbook (antora-playbook.yml) and component version descriptors (antora.yml), honoring any escaped attribute references.

Issue #984

Define exports for all packages, locking down what paths can be required to the public API.

Issue #988
  • Add reftype key with value of branch or tag to source object in structured log message.

  • Add reftype property to origin object to explicitly identify type of git reference (branch or tag).

  • Add remote key with value of remote tracking branch to source object in structured log message, if applicable.

  • Add remote property to origin object to identify a remote tracking branch.

  • Add local key with path of local repository to source object in structured log message, if applicable.

Changed

Issue #900

Include target in error message for broken or cyclic symbolic link in local content source or UI bundle directory.

Issue #979

Set Node.js 16.0.0 as minimum supported Node.js version. Upgrade dependencies that require Node.js > 12 and remove workarounds.

Issue #982

Move logic to collate AsciiDoc attributes to a helper function. Use helper function to collate AsciiDoc attributes from playbook and component version.

Issue #985

Add context to error and preserve cause if failure occurs when reading supplemental UI files.

Issue #986

Log warning message instead of throwing fatal error if file in worktree disappears or cannot be read.

Issue #988

Consistently format origin information in log and error messages.

Issue #993

Set worktree property on origin to false when branch or tag is local but not taken from worktree. Use isolated Handlebars environment instead of the default (global) environment.

Fixed

  • Don’t append undefined after path of file in stack in pretty log format if line is missing.

  • Make warning message about missing page layout consistent with other log messages.

Removed

Node.js 12 and 14 support

Antora no longer supports Node.js < 16 (specifically dropping support for Node.js 12 and 14) since those Node.js release lines are now EOL. This change is consistent with Antora’s Node.js support policy.

Antora 2 is EOL

Antora 2 is EOL. Review the checklist on Upgrade Antora to learn about what changes you should make to your source content, including AsciiDoc syntax and Asciidoctor updates introduced in Asciidoctor 2.2, and Antora configuration prior to upgrading to from Antora 2 to Antora 3.1.

Thank you!

Most important of all, a huge thank you! to all the folks who helped make Antora even better. The Antora community has provided invaluable feedback and testing help during the development of Antora 3.1.

We also want to call out the following people for making contributions to this release:

Gautier de Saint Martin Lacaze (@jabby)

Add removeFile method to contentCatalog and uiCatalog (#814).