-
Notifications
You must be signed in to change notification settings - Fork 687
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
Migrate PWA Studio to magento Organization #1472
Comments
Are there any inbound/outbound links that we need to worry about breaking during the move? Docs, wiki, confluence, etc.? |
Added to the list 👍 We should definitely update those but GitHub will redirect for us in the meantime. The way I understand it, nothing will break. 🤞 |
If we have a not-clone repo with a copy of all the code, and As I understand it, that's how quite a few projects are keeping track and using PWA Studio today. No idea if Git or GitHub gracefully handles that redirect. Probably not I'm guessing. Could be a confusing day weeks down the line if Git starts saying remote not found. Not sure there's any way around it if the redirect doesn't apply. |
Good point - @Jordaneisenburger that's how fallback studio works, right? From what I understand, GitHub will redirect HTTP(S) and SSH requests to |
From https://help.github.com/en/articles/transferring-a-repository:
|
@supernova-at Fallback Studio is a full wrapper around the whole PWA Studio repo. It's used as a vendor and so Studio lives inside the fallback studio repo. Meaning that it wouldn't crash if the Studio repo changed. I just have to update my upgrade script to get the latest Studio version from the new repo i think |
Okay here is EngCom's checklist from previous repository transfers:
Here are some thoughts / questions on the above:
✅ Added to our checklist Seems like a good idea "just in case". I don't think we want to officially duplicate a repository, but it would be smart to make sure we have a copy of the full repo somewhere (even if it's just locally on someone's machine) before we initiate the transfer. Questions:
❌ Did not add to our checklist If we don't do the full duplication we don't have to do this step, as the redirects won't kick in until we do the actual transfer.
✅ Added to our checklist I think we can get a list of folks who've contributed but where does that leave new contributors? Is there a process for them to get themselves added to Community Contributors team?
❌ Did not add to our checklist Not needed for PWA.
✅ Added to our checklist I'm assuming
✅ Added to our checklist Questions:
✅ Added to our checklist I'm assuming EngCom will run point on these 😄
❌ Did not add to our checklist We should probably plan for a hiccup or two next time we use the automated release scripts. Updates can happen at that time. |
@supernova-at.
Take attention to project collaborators, because they permissions will not be transferred automatically.
|
From Transferring a Repository:
WebhooksZenHub, CLA, AWS Webhooks, AWS Code Build Won't post details here, have info locally. GitHub Apps
Danger-JSCode UpdateCovered by steps in API Token Update
Update the API Token. @sharkySharks , how can we get a new token for this? Update Repository Access
NowCode UpdateI think the only thing we have to update is https://github.com/magento-research/pwa-studio/blob/a294b1fbad4c04b5a13e5af34ea26b1050f765f0/now.json#L7. Edit: PR opened here: #1488. Update Repository Access
bundlesizeUpdate Repository Access
MiscellaneousDockerNothing to do here. (Can you verify, @sharkySharks ?) AWS CodePipelineUpdate: Builds: all of them AWS CodeBuildUpdate the primary repository pwa-studio-cicd repositoryUpdate all references to Edit: This PR is located here: https://github.com/magento/pwa-studio-cicd/pull/13 |
When we communicate the move to the community, this will be useful:
|
GitHub Pages Migration Plantl;drThe existing docs site may We will update the docs site before the move to redirect to the new location. This way if stale content is served, it will redirect to the new content. We will also have to be proactive about communicating that the docs site has moved because GitHub will not automatically redirect traffic to it. Overview / ContextCurrently, our repository publishes to a GitHub Pages site. It accomplishes this by maintaining a We also have a custom domain http://pwastudio.io which redirects to https://magento-research.github.io/pwa-studio/. @ericerway owns http://pwastudio.io. The ProblemIn what's transferred with a repository, GitHub says:
When we move the Which means that anyone that has bookmarked https://magento-research.github.io/pwa-studio/ will not be redirected to the new https://magento.github.io/pwa-studio/. Because http://pwastudio.io is a simple redirect, most / all bookmarks will directly point to https://magento-research.github.io/pwa-studio/, not http://pwastudio.io itself. Further, once we move the repository and there no longer exists a repo at Edit: In isaacs/github#492, a user commented that they moved their repository to a different organization but their old repo's GitHub Pages site still stands (over two years later). Old: https://kanaka.github.io/noVNC/, New: https://noVNC.github.io/noVNC/ Long story short, we will be leaving a lot of folks with a bookmark to a site that won't exist or has stale content. Possible SolutionsWaitThe idea here is that we put up a banner on the existing https://magento-research.github.io/pwa-studio/ site that lets visitors know that the docs site will be moving. We'd need to decide how much time is "enough", but we wouldn't actually perform the move until the banner has been up for that amount of time. CommunicateThis is the same as Another downside is that anyone who has the docs site bookmarked but isn't in our Slack wouldn't be notified of the move. This is the same outcome as if they didn't visit the site and read the banner, however. Pre-Move UpdateIn a GitHub issue comment, the
Indeed, two plus years after that comment, http://kanaka.github.io/noVNC/ is still serving stale content (http://noVNC.github.io/noVNC/ is the updated site). The idea here is to update In this way we can preserve all existing bookmarks to https://magento-research.github.io/pwa-studio/. Note that there will be a short amount of time between when we make this change and when the repository gets moved that the docs site will Re-create PWA Studio in magento-researchThe repo would only contain the This would prevent https://magento-research.github.io/pwa-studio/ from Unfortunately, this would probably also break any automatic redirecting that GitHub would do for us so that HTTP(S) / SSH traffic gets redirected to |
Installing Required GitHub Appsbundlesizehttps://github.com/siddharthkp/bundlesize Enabling: https://github.com/siddharthkp/bundlesize#build-status-for-github Danger-JShttps://github.com/apps/danger-js Now |
Create ticket in JIRA - please check pwa-studio CLA integration Edit: Done. |
Suggestion: after the move, add PWA Studio to the pinned repositories for the |
Closing. Move complete! |
https://help.github.com/en/articles/transferring-a-repository#whats-transferred-with-a-repository
https://help.github.com/en/articles/transferring-a-repository#transferring-a-repository-owned-by-your-organization
Plan of action:
🔁 denotes an item in progress
Before the Move
pwa-studio
repositoryDone: Migrate PWA Studio to magento Organization #1472 (comment).
Done: Migrate PWA Studio to magento Organization #1472 (comment).
Done: https://github.com/magento-research/pwa-studio-copy.
Done: Migrate PWA Studio to magento Organization #1472 (comment).
Done: Updates GitHub Pages to redirect to pwastudio.io #1494.
magento
organization has thebundlesize
,Danger-JS
, andNow
Apps that the magento-research organization hasDone: It does not, but we can install them
Move
404
ing)pwa-studio-copy
mirror with the latest changespwa-studio
tomagento
organization on GitHub. Instructions here.pwa-studio-cicd
repoAfter the Move
Owned by Us
pwa-studio
markdownDone: Updates repository references after the move #1511 .
pwa-studio
wikidev-docs
pwa-tests
repoUpdate: none found
Created Issue: Update Repository References in Internal Tools #1524.
Created Issue: Delete pwa-studio-copy Repository #1525.
magento
organization:upward-php
magento2-upward-connector
pwa-tests
express-sharp
venia-consumer-example
Created Issue: #1526.
Known Issues
Issue Created: Now.sh #1519.
Issue Created: Coveralls Reporting #1520.
Done: Folks may have to re-sign the CLA in the
magento
org. Working for new contributors.404
sOwned by EngCom
pwa-studio
as a pinned repository inmagento
pwa-studio
The text was updated successfully, but these errors were encountered: