It seems the way to use autodoc currently is to add the workflow in the ci pipeline, so that it commits changes to the workflow documentation as commits in the PR the dev is working on. To me this seems like a less than ideal workflow since it pushes the commits to my branch while I am working on the feature. A better workflow could be to run the workflow in the cd pipeline so it commits the changes directly to the main branch, after the changes is merged, so it does not "interfer" with the development workflow. However, maybe this is kind of bad (for security?), to push directly to main like that.
So! I thought maybe it could be integrated with the release workflow, so that the autodoc based changes gets added to the release PR that release-please creates? This way, autodoc changes can be verified on the release please branch before merge.
It seems the way to use autodoc currently is to add the workflow in the ci pipeline, so that it commits changes to the workflow documentation as commits in the PR the dev is working on. To me this seems like a less than ideal workflow since it pushes the commits to my branch while I am working on the feature. A better workflow could be to run the workflow in the cd pipeline so it commits the changes directly to the main branch, after the changes is merged, so it does not "interfer" with the development workflow. However, maybe this is kind of bad (for security?), to push directly to main like that.
So! I thought maybe it could be integrated with the release workflow, so that the autodoc based changes gets added to the release PR that release-please creates? This way, autodoc changes can be verified on the release please branch before merge.