Migrate Material for MkDocs sponsorship to weaveworks-sponsor-bot, fork repo
Closed this issue · 4 comments
Relates to https://github.com/weaveworks/corp/issues/1446
Rationale
For business continuity purposes, we need to migrate to using a bot for access to the private squidfunk/mkdocs-material-insiders repository.
Timing
I'd like to do this in the near future (next week?) There will be a period (hopefully, less than a day) where you won't be able to access the insiders repository during the migration. If you have not already done so, I suggest creating a fork on your personal GitHub account if necessary.
Outline
I'll have to:
- grant access to this repo for the bot
- email the maintainer & wait for him to change the sponsorship
- generate a token for the bot, add to org secrets and make it available to this repo for GitHub Actions
- fork & reconcile the insiders repo
Either you or I can then update .github/workflows/ci.yml to use our fork.
Given our timezone difference, I suggest it makes sense for me to start this one morning my time: hopefully, I'll be done by the time you come online.
An improvement to forking would be:
- create a new target repo for a clone of the private repo
- use e.g. a GitHub Action such as https://github.com/marketplace/actions/github-repo-sync to keep our new copy in sync with upstream.
This would mean even if we stopped sponsoring (or the maintainer went mad and deleted our access or his repo), we'd still have a recent clone of the code.
References
Per the Material for MkDocs sponsorship page:
To ensure that access is not tied to a particular individual GitHub account, create a bot account (i.e. a GitHub account that is not tied to a specific individual), and use this account for the sponsoring. After being added to the list of collaborators, the bot account can create a private fork of the private Insiders GitHub repository, and grant access to all members of the organizations
@morancj is it OK to close this now that the WKP docs are live?
@palemtnrider No, if anything, that makes it more important that we move this subscription to a company-owned bot account, fork or clone (clone is safer as if upstream deletes their repo, our fork would also be deleted), and add some users to our repo mgmt. Add an Action (or similar) to sync as above.
If we're no longer using mkdocs-material, we can close this @abuehrle, ref. https://github.com/weaveworks/corp/issues/1446
We can close this = docusaurus!