bcgov / devhub-app-web

Web application for the DevHub
https://developer.gov.bc.ca/
Apache License 2.0
23 stars 33 forks source link

Use main branch for Design System topicRegistry target #1815

Closed ty2k closed 9 months ago

ty2k commented 9 months ago

Summary

I've renamed the default branch of the bcgov/design-system repository to main from master, and this PR explicitly updates the design system's topicRegistry JSON data to point to that branch.

I think based on this function in the devhub-markdown-frontmatter-verify GitHub Action that this change isn't actually necessary to get the design system content to be picked up by the DevHub build. However, I wanted to make the change proactively in case the build fails, so it's not a bad surprise while you're updating some other part of the application.

ty2k commented 9 months ago

Thanks for taking a look @MonicaG! I've renamed the branch already and found that doing that broke some inline <component-preview> iframe previews on DevHub which were pointing to the master branch of bcgov/design-system. I hotfixed that by just cutting a new master branch from main in that repo, and the iframes started working again.

I've updated the design system's internal references to use main in this PR, but I'll keep that master branch going until DevHub is retired.

Like you, I don't want to spend anymore time worrying about this app, so feel free to close this! :)

MonicaG commented 9 months ago

Closing without merging as per @ty2k and my above discussion.