Add new workflow to trigger building and publishing docs, fix release-prod docs step #185
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…g and publishing into a triggerable workflow that's reused
jhamon
approved these changes
Jan 13, 2024
| user-email: [email protected] | ||
| target-branch: main | ||
| target-directory: typescript | ||
| commit-message: 'TypeScript: automated documentation build - pinecone-ts-client merge SHA: ${{ github.sha }}' |
There was a problem hiding this comment.
I think an extra empty line between commit title and body is conventional.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
We pushed a patch to fix up our npm release page. In doing this I realize the
release-prodworkflow is incorrectly still trying to push the built client docs to thegh-pagesbranch. It should be moving things to thesdk-docsrepo like inmerge.Solution
build-and-publish-docsworkflow to allow triggering a fresh docs build and deploy off main separate from other workflows.release-prodto use this new workflow if the npm release completes. Also uncommented the test re-use with the boolean flag in that workflow as it surprised me it immediately pushed to npm without any other checks.build-and-publish-docs.Type of Change
Test Plan
We'll have to test the release workflow by actually releasing, so give that a careful review. The docs workflow can be triggered and tested on its own.