-
Notifications
You must be signed in to change notification settings - Fork 8
"stable" and "dev" version automatic inference
Michael Jonker edited this page Sep 12, 2022
·
2 revisions
Typedoc-plugin-versions gives priority to "stable" and "dev" versions explicitly set in the user options.
if no versions are explicitly set, it will automatically infer these links according to the Semantic Versioning Specification.
Note that for all the below examples, all typedoc-plugin-versions options were left at their defaults, i.e. fully automatic.
- A package that has not yet released a version marked as stable:
- A package having just released their first stable version:
- A package with a previously released version 1.0.0, now releasing version 1.1.0-alpha.1
Here, thestable
symlink points to version 1.0.0, and thedev
andv1.1
symlinks points to version 1.1.0-alpha.1 - A package releasing version 1.1.0, which supersedes the prerelease version 1.1.0-alpha.1:
Now,stable
,dev
andv1.1
symlinks all point to version 1.1.0 - A package with a previously released stable version 1.2.0, now releasing the prerelease version 1.2.1-alpha.1:
Here,stable
andv1.2
both point to the previous version 1.2.0, while onlydev
points to 1.2.1-alpha.1