Remove merge
workflow and update build-and-publish-docs
workflow to be manually runnable
#335
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
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
callsbuild-and-publish-docs
on every merge tomain
. 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
merge.yaml
workflow entirely. Previously it was only dealing with building and deploying the reference docs.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
Test Plan
Make sure nothing is triggered on merge to
main
.