I'm looking for recommendations on how to remove versions from a Mkdocs site published with GHA. I have two scenarios where I need things deleted -- a one time process because of a mistake in initial deploying the site, and the other -- an ongoing need to remove "release candidate" builds.
I specifically want to remove the version "docs-v0.12.0rc1" as it was created while I was trying to figure out the best flow for our situation.
We publish "Release Candidates" such as 0.12.0rc1, 0.12.0rc2. As we finalize the release (e.g., when 0.12.0 is released), I'd like to remove the release candidate docs from the published site.
Is there a recommend way to do that? Ideas I've had:
Edit the gh-pages branch and remove the version folders and the versions from the "versions.yml". But I think that messes think up with the sitemap, and generally seems like a bad approach.
Add a temporary mike delete <version> call for the specific versions to be deleted, making sure to ignore the error if the version is not there (e.g., it has already been run and deleted).
Create a manually triggered GHA that takes a parameter of the version to be removed. The GHA would run mike delete <version>.
Currently we are triggering a version by adding a branch docs-v<version>. Create a GHA that runs on delete and that deletes the version associated with the delete branch.
I'm looking for recommendations on how to remove versions from a Mkdocs site published with GHA. I have two scenarios where I need things deleted -- a one time process because of a mistake in initial deploying the site, and the other -- an ongoing need to remove "release candidate" builds.
GitHub repo: https://github.com/hyperledger/aries-cloudagent-python Deployed pages: https://hyperledger.github.io/aries-cloudagent-python/ GHA: https://github.com/hyperledger/aries-cloudagent-python/blob/main/.github/workflows/publish-docs.yml
I specifically want to remove the version "docs-v0.12.0rc1" as it was created while I was trying to figure out the best flow for our situation.
We publish "Release Candidates" such as 0.12.0rc1, 0.12.0rc2. As we finalize the release (e.g., when 0.12.0 is released), I'd like to remove the release candidate docs from the published site.
Is there a recommend way to do that? Ideas I've had:
mike delete <version>call for the specific versions to be deleted, making sure to ignore the error if the version is not there (e.g., it has already been run and deleted).mike delete <version>.docs-v<version>. Create a GHA that runs ondeleteand that deletes the version associated with the delete branch.Suggestions would be welcome!
Thanks!