docs(version): ✨ Pulling version number from helia. #290
Conversation
| @@ -33,8 +33,9 @@ | |||
| "release": "run-s build docs:no-publish npm:release docs", | |||
| "npm:release": "aegir exec --bail false npm -- publish", | |||
| "release:rc": "aegir release-rc", | |||
| "docs": "NODE_OPTIONS=--max_old_space_size=8192 aegir docs -- --exclude packages/interop --excludeExternals", | |||
| "docs:no-publish": "NODE_OPTIONS=--max_old_space_size=8192 aegir docs --publish false -- --exclude packages/interop" | |||
| "update:version": "node scripts/update-version.js", | |||
There was a problem hiding this comment.
this does not commit anything back to main, only the docs.
There was a problem hiding this comment.
Please can we be careful about the commit messages used as they will affect final version numbers of shipping software.
This is not a feature so feat: is inappropriate. Instead, please choose from the available tags - docs: seems like the obvious one to me.
If necessary please review the Conventional Commits documentation.
|
This is a strange fix because v2.0.3 is the current version of helia which is compliant with v2.0.0 of the helia interface. In theory we'll see lots of patch releases of helia but very few releases to the interface. The API docs are monorepo docs rather than specific to a given module and the version number comes from the root package.json. Perhaps there's a config key for the root typedoc.json to remove display of the monorepo version as it doesn't make much sense to the consumer? Then we don't need contortions like the one introduced in this PR. |
whizzzkid
force-pushed
the
feat/versioned-docs
branch
from
c777d83
to
a43823a
Compare
whizzzkid
changed the title
|
@achingbrain However, I still think there is value in having the version number that corresponds to the latest helia. The interface correctly describes the current version as well. |
It was being hard-coded in aegir's |
|
Alternative: #296 |
|
Closing in favour of #296 |
Fixes the package version on the docs hosted on helia.io.
helia.package.jsonThis should fix the version in the next release.