-
Type: Improvement
-
Resolution: Unresolved
-
Priority: Unknown
-
None
-
Affects Version/s: None
-
Component/s: Release Automation
As a node driver engineer,
I want the docs to generated automatically as a part of the release process,
so that the docs stay up to date without manual work.
Notes
Our current release process involves manually rebuilding our API documentation for major or minor releases. We should automate this process.
The release script and the documentation generation script will need to be enhanced to detect the version being released, determine if this is a new major or minor, and rebuild the docs if necessary.
Acceptance Criteria
- For a major or minor release, the command `npm run release` detects the correct version and rebuilds our API docs to include the new version.
- For a patch / beta / alpha release, the command `npm run release` generates the correct api docs but hosts them under the previous major / minor tag in our api docs.