Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs build and deploy to release-prod workflow #127

Merged
merged 1 commit into from
Sep 29, 2023

Conversation

austin-denoble
Copy link
Contributor

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 the package.json version and pushes this with [skip ci] in the commit message, which doesn't trigger any of our merge/commit workflows:

git commit -m "[skip ci] Publish release v$newVersion"

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: (explain here)

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 in merge.yml.

Pushing these changes should also trigger a merge run which should fix up the current mismatch in the docs.

@austin-denoble austin-denoble merged commit 62dd20f into main Sep 29, 2023
18 checks passed
@austin-denoble austin-denoble deleted the adenoble/add-docs-deploy-to-release branch September 29, 2023 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants