Deploy storybook for every pull request

[patcon]

We can use this branch-switcher addon for storybook to allow the single storybook site to switch between code from different branches/PRs: https://github.com/utarwyn/storybook-branch-switcher

It can have each PR generate a build of storybook for its branch: https://github.com/utarwyn/storybook-branch-switcher?tab=readme-ov-file#with-github-opened-prs

Unlike traditional PR flows, it's not deployable a new app for PRs, but instead pushing to the github pages main site (usually only deployed from main branch) for every commit to both mainline and pull request branches.

To Dos

• [x] fix branch selector widget in storybook itself
  • links to https://civictechto.github.io/PR-7/ instead of https://civictechto.github.io/polis-storybook/PR-7/
• [x] add submodule updates into storybook addon itself
• [x] run npm install as part of branch build, to ensure pkgs even when package.json differs
• [x] figure out why main branch isn't building/deploying properly for PRs (seems to get stripped envvar, which is used in addon to pass state around. maybe a github actions security feature?)
  • links to (for example) PR-7, also get mangled into
  • https://civictechto.github.io/polis-storybookPR-7/polis-storybook/?path=/docs/overview--docs instead of
  • https://civictechto.github.io/polis-storybook/PR-7/?path=/docs/overview--docs
  • RESOLVED by switching to pull_request_target trigger 9a3a26c
• [x] fix bug with branch switching between non-default branches. Details 8cf21d2ce0d153a0f442aea58ce3b352eb8ab8b8
  • potential fix: https://github.com/utarwyn/storybook-branch-switcher/pull/16
• [x] auto-post link to branch storybook to PR 1aed13d
  • https://github.com/marketplace/actions/comment-pull-request
  • https://github.com/ouzi-dev/commit-status-updater

[patcon]

This might require some silliness and edge cases when adding new packages in a PR, because they might be missing if that packages are only pulled in from package-lock.json in mainline. To make this work, packages may need to be added to mainline for work happening on branches.

Alternatively, we could gradefully exit the storybook build for branches where diffs exist between the package-lock.json in mainline and a PR branch

[patcon]

Yay, working (ish)

First branch deploy is #7 at https://civictechto.github.io/polis-storybook/PR-7/

Automation runs on each push to mainline and to PRs.

[patcon]

Took a bit to figure this out, as it's a little messy (with submodules and checking out branches based on remote branch hashes on github), but this is now working fine!

Will likely have some funny edge-cases for git submodules when the commits update between branches, but works really well for now!

[patcon]

In future, might also want to consider using the pull_request_target workflow trigger instead of the default pull_request

[patcon]

This is done now, as far as I can tell 🎉