Mkdocs Publish Only on Release or Manual Trigger #511
Merged
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.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
We want to stop doc drift and only have docs publish on release. Eventually, we want to version the docs by release. ATM, the doc site will be updated with whatever is in main on release. We may need to do additional work here with $id updates.
Changed our action to run when new stable release is published. See https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#release for full list of possible release events to subscribe to.
This will still ultimately release what's in main, so if our release process puts all release schema $ids in a release branch, this won't publish the precise release schemas and $ids, so we may need to make further changes. This is happening anyway, however, so this PR will still improve the current situation.
Possibly we make the release process a Github action. These can be triggered manually via Github UI if you add a
workflow_dispatch:
trigger. We could do both the final schema updates - changing ids to release ids - and the mk docs publication from the same action.Which issue(s) this PR fixes:
Fixes #510