docs(toolkit-lib): include VERSION file
#131
Conversation
| // This is required because the zip file needs to have this structure when created | ||
| toolkitLib.packageTask.spawn(toolkitLibDocs, { args: ['--out dist/docs/cdk/api/toolkit-lib'] }); | ||
| // The docs build needs the version in a specific file at the nested root | ||
| toolkitLib.packageTask.exec('(cat dist/version.txt || echo "latest") > dist/docs/cdk/api/toolkit-lib/VERSION'); |
There was a problem hiding this comment.
dist/version.txt is only available during release. Otherwise just default to the generic latest.
There was a problem hiding this comment.
Not that it really matters but wouldn't it make more sense to default to 0.0.0 - which is the version number during development?
There was a problem hiding this comment.
My thinking was that worst case scenario we will show "latest" on the docs website. That feels better than accidentally showing "0.0.0".
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #131 +/- ##
==========================================
- Coverage 84.83% 84.53% -0.30%
==========================================
Files 196 196
Lines 35089 35089
Branches 4540 4533 -7
==========================================
- Hits 29768 29663 -105
- Misses 5178 5288 +110
+ Partials 143 138 -5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Removed from queue if you want to address the comment |
3 participants
The docs build requires this file to contain the current version number.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license