A patch release. Under the github-release version source, a docs-only pull request
labelled docs/release can now republish the docs instead of failing after the merge.
Nothing changes for descriptor or tag-bump. The workflows call a new CLI flag, so update
the CLI first. Existing sites only get the new workflows by running docouture upgrade.
Do this
-
Update every
@inditextech/docouture-*package, and the CLI if you install it, to1.4.1, and install. The generated workflows run the CLI your project installed, and they now passdocouture release resolve --releases, which older CLIs do not accept. -
Run
docouture upgrade, review the diff, and commit.github/workflows/. See CLI. -
If your Release tags carry a prefix, for example
my-lib@1.4.1in a repository that publishes several packages, setdocouture.versionSourcePrefix(for example withdocouture version-source github-release --prefix my-lib@) so the right Release is picked. The prefix applies to the Release tags, not to thedocs/v*tags the workflow creates. Without a prefix, only plain SemVer Release tags such as1.4.1are considered, and prefixed tags are ignored. A repository with plain tags, like this one, needs nothing.
What changed
-
Changed: a docs-only
docs/releasepull request no longer fails undergithub-release. The workflow lists the repository’s published, non-draft, non-prerelease GitHub Releases, anddocouture release resolverepublishes the docs at the highest SemVer among them, filtered bydocouture.versionSourcePrefix. SemVer prereleases such as1.5.0-rc.1and non-SemVer tags are ignored. The tag is force-recreated like any republish, with no descriptor bump and no git-flow sync. With no usable Release, the merge fails with a message naming the prefix and how many releases were considered. -
New:
docouture release resolve --releases <a,b>. The Release tags to choose from. Their order does not matter, and--release-tagstill takes precedence. -
Changed: the release preview under
github-release. Adocs/releasepull request now says merging republishesdocs/vX.Y.Z, or warns that no Release was found. A pull request that also hasrelease-type/*keeps the "docs follow the code release" comment. The preview job now runs your package manager’s install undergithub-release, liketag-bump. -
New: a scenario-by-source table of what each trigger releases, in main:guides-releasing-a-documentation.adoc#release-scenarios.