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

Remove merge workflow and update build-and-publish-docs workflow to be manually runnable #335

Merged

Conversation

austin-denoble
Copy link
Contributor

@austin-denoble austin-denoble commented Apr 25, 2024

Problem

Currently, we have a couple different GitHub workflows which deal with building and publishing the client reference documentation:

  • merge.yaml
  • build-and-publish-docs.yaml

merge calls build-and-publish-docs on every merge to main. This is problematic as any changes that are made which change documentation will be reflected at in the Python client reference as soon as they are merged to main even if we haven't cut a release.

Solution

  • Remove the merge.yaml workflow entirely. Previously it was only dealing with building and deploying the reference docs.
  • Update build-and-publish-docs to be a manually runnable or callable from another workflow.

For now, we can manually trigger new reference docs builds as needed, most likely after we cut a release. This isn't the best solution, but I think it's important to get this process out of the merge action, and we can iterate on it later.

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

Make sure nothing is triggered on merge to main.

@austin-denoble austin-denoble requested a review from jhamon April 25, 2024 22:08
@austin-denoble austin-denoble merged commit e123da1 into main Apr 29, 2024
125 checks passed
@austin-denoble austin-denoble deleted the adenoble/remove-merge-update-docs-build-workflow branch April 29, 2024 14:55
mcpaddy added a commit to mcpaddy/pinecone-python-client that referenced this pull request May 22, 2024
* 'main' of github.com:pinecone-io/pinecone-python-client:
  [skip ci] Bump version to v4.1.0
  Bump tqdm from 4.66.1 to 4.66.3 (pinecone-io#344)
  Bump idna from 3.4 to 3.7 (pinecone-io#345)
  Bump jinja2 from 3.1.3 to 3.1.4 (pinecone-io#343)
  Add better error messages for mistaken `from_texts` and `from_documents` (pinecone-io#342)
  Support proxy_url and ssl_ca_certs options for gRPC (pinecone-io#341)
  Remove serverless public preview warnings (pinecone-io#340)
  [skip ci] Bump version to v4.0.0
  Improve upsert throughput by 3x (pinecone-io#334)
  Remove `merge` workflow and update `build-and-publish-docs` workflow to be manually runnable (pinecone-io#335)
  [skip ci] Bump version to v3.2.2
  [Fix] openapi_config deprecation warning incorrectly shown (pinecone-io#327)
  Add grpc unit test run, expand testing of VectorFactory (pinecone-io#326)
  [skip ci] Bump version to v3.2.1
  Allow clients to tag requests with a source_tag (pinecone-io#324)
  [skip ci] Bump version to v3.2.0
  Revise proxy configuration, add integration testing (pinecone-io#325)
  [Fix] Configuring SSL proxy via openapi_config object (pinecone-io#321)
  Update README.md (pinecone-io#323)
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