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

Mkdocs Publish Only on Release or Manual Trigger #511

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

JSv4
Copy link
Contributor

@JSv4 JSv4 commented Aug 1, 2024

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

Changed github action to only release new docs 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
@jacobyavis jacobyavis self-requested a review August 1, 2024 16:48
@JSv4
Copy link
Contributor Author

JSv4 commented Aug 7, 2024

@jacobyavis, can you review this one when you have a chance? If you have time to test the action, elsewhere, would welcome confirmation this will work.

Copy link
Collaborator

@jacobyavis jacobyavis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for doing this!

@JSv4 JSv4 merged commit 0b3f70c into main Aug 15, 2024
6 checks passed
@JSv4 JSv4 deleted the JSv4-mkdocs-only-on-publish branch August 15, 2024 03:50
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.

[Enhancement]: Unlink Mkdocs Publication from Merge Actions
2 participants