Add docs build and deploy to release-prod workflow #127
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Yesterday @jhamon released a new version of the TypeScript SDK: v1.1.0. After completing the upgrade the client's documentation was out of sync, showing v1.0.1 instead of the latest: https://pinecone-io.github.io/pinecone-ts-client/
The issue is the
release-prod
workflow makes changes to thepackage.json
version and pushes this with[skip ci]
in the commit message, which doesn't trigger any of our merge/commit workflows:pinecone-ts-client/.github/actions/npm-release/action.yml
Line 36 in 6a753e3
Solution
To keep the client's documentation in sync, we can add the documentation generation steps to
release-prod.yml
. This will ensure documentation is properly re-generated after a version bump.We shouldn't need to make any changes around
release-dev.yml
as we don't actually commit anything to the repo in this workflow.Type of Change
Test Plan
We're unable to test the
release-prod.yml
workflow without actually releasing, but the addition to the workflow file is identical to what's currently inmerge.yml
.Pushing these changes should also trigger a merge run which should fix up the current mismatch in the docs.