FI-3642 Updates wiki workflow to allow manual synchronization for previewing. #607
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Allows users to 'preview' docs changes to the wiki, as in practice it is hard to ensure that docs changes look and work properly within the wiki which ends up creating a lot of junk PRs. Enables the workflow to be run manually via the Actions against any branch.
Also automatically resynchs wiki docs to(removed that run-on-close feature because it is spammy on merges, which counts as a PR closure)mainon closure for any PR that has docs changes, just in case it was manually synchronized but not undone.Originally I created a workflow that would synchronize to the wiki automatically if a title contained something like '(DOCS)' in it.
But this requires people to know that this functionality exists. And at that point, it just seems simpler to allow manual execution of this via the workflow tab. So, the user opens a PR, goes to the Actions area, runs this against the new branch, which synchronizes the wiki. Takes a look. And then can resynchronize it back to main if they want, or let the reviewer take a look.
Less code, less magic stuff happening automatically.
I confirmed it work over here so I think this is a low risk merge with limited review: arscan/docs-test-kit#7.