Commit e123da1
authored
## 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](https://sdk.pinecone.io/python) 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
- [X] Infrastructure change (CI configs, etc)
- [X] Non-code change (docs, etc)
- [ ] None of the above: (explain here)
## Test Plan
Make sure nothing is triggered on merge to `main`.
1 parent c5ba9ce commit e123da1
1 file changed
+6
-5
lines changedLines changed: 6 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
5 | | - | |
6 | | - | |
7 | 4 | | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
| |||
29 | 30 | | |
30 | 31 | | |
31 | 32 | | |
32 | | - | |
| 33 | + | |
0 commit comments