Skip to content
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

[WEB-3364] Storybook migration: remove Rails, setup GH Pages deployment #321

Merged
merged 3 commits into from
Mar 20, 2024

Conversation

jamiehenson
Copy link
Member

@jamiehenson jamiehenson commented Mar 15, 2024

Jira Ticket Link / Motivation

This PR is 4 of 6 when it comes to the Storybook migration. With #302, we now have a functioning Storybook integration for our Ably UI assets. This PR is all about gutting out all the old Rails assets that are no longer used, and providing a cleaner way of deploying the new assets - in this case, using Github Actions to deploy the static Storybook site to Github Pages.

Jira link: https://ably.atlassian.net/browse/WEB-3364

After this is a TSX rewrite of the Ably UI JSX components, and an investigation into swapping out Webpack as the build tool in favour of Vite.

Summary of changes

  • Deployment path to GitHub Pages added to GitHub actions, which triggers on release
  • Linting/formatting checks moved to GitHub Actions
  • CircleCi config stubbed to run with a noop, to satisfy checks until it can be disabled for this repo
  • Rails preview folder removed
  • All references to Rails/Ruby processes, and Ruby assets removed

How do you manually test this?

Pull it down, get the latest packages, make sure Storybook still runs. Upon release, we'll see whether the deployment works correctly (note: I tested this exact deployment on branch push, and it worked - deploying successfully to https://ably.github.io/ably-ui.

Reviewer Tasks (optional)

Merge/Deploy Checklist

  • Written automated tests for implemented features/fixed bugs
  • Rebased and squashed commits
  • Commits have clear descriptions of their changes
  • Checked for any performance regressions

Frontend Checklist

  • No frontend changes in this PR
  • Added before/after screenshots for changes
  • Tested on different platforms/browsers with Browserstack
  • Compared with the initial design / our brand guidelines
  • Checked the code for accessibility issues (VoiceOver User Guide)?

@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-d5ddhtgbh March 15, 2024 12:58 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-ihuztzwco March 15, 2024 16:28 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-hy7apztu7 March 15, 2024 16:40 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-sopgklhpg March 15, 2024 16:45 Inactive
@jamiehenson jamiehenson changed the base branch from main to add-storybook March 15, 2024 16:48
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-hsyvwb1je March 15, 2024 17:03 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-pr1bbgb6p March 18, 2024 13:36 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-t9lla2vpp March 18, 2024 13:40 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-ln8mrlxhb March 18, 2024 13:47 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-32jees4ds March 18, 2024 14:02 Inactive
@ably-ci ably-ci had a problem deploying to ably-ui-kill-preview-zh1z71fie March 18, 2024 14:05 Failure
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-mc8vcvh6g March 18, 2024 14:16 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-o9skglpia March 18, 2024 14:35 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-e2jyjzyun March 18, 2024 14:43 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-zbabc3il3 March 18, 2024 14:47 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-1vhqslgc3 March 18, 2024 15:46 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-hhalogce8 March 18, 2024 15:49 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-idnsmbagy March 18, 2024 16:19 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-edhyidllj March 19, 2024 15:09 Inactive
Base automatically changed from add-storybook to main March 20, 2024 11:10
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-eo17acxuk March 20, 2024 11:27 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-3aee56gjn March 20, 2024 11:32 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-o65ect8cc March 20, 2024 11:37 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-omv2cnyn6 March 20, 2024 11:40 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-dyrbkhdaw March 20, 2024 11:41 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-t8ubsmpem March 20, 2024 11:45 Inactive
@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-uz7btaxv4 March 20, 2024 11:48 Inactive
@@ -8,121 +8,121 @@
* - Please do NOT serve this file on production.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes here due to linting requirements

@@ -1,28 +1,21 @@
Jira Ticket Link / Motivation
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes here due to linting requirements

@@ -5,58 +5,132 @@ import Icon from "../core/Icon/component.jsx";

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes here due to linting requirements

@ably-ci ably-ci temporarily deployed to ably-ui-kill-preview-rt1dujl6e March 20, 2024 11:54 Inactive
@jamiehenson jamiehenson marked this pull request as ready for review March 20, 2024 11:54
@jamiehenson
Copy link
Member Author

What I have here works and I feel I've chopped as deeply as I'm able to, but given that the criteria I have visibility over is mainly "does Storybook still work", I need some guidance on what happens regarding package deployment @kennethkalmer. I think this should work as I've not fundamentally touched anything there, but so much has been knifed I'm not 100%.

Copy link
Member

@kennethkalmer kennethkalmer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @jamiehenson! well done on being well on your way to having a total net-negative contribution 🤣🎖️

@@ -2,9 +2,6 @@
"buildpacks": [
{
"url": "https://github.com/timanovsky/subdir-heroku-buildpack"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We won't need the subdir buildpack either since this was how we deployed preview on Heroku review apps I see storybook outputs to preview

Copy link
Contributor

@aleksandar-r aleksandar-r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work @jamiehenson, truly remarkable

@jamiehenson jamiehenson merged commit d9cd953 into main Mar 20, 2024
6 checks passed
@jamiehenson jamiehenson deleted the kill-preview branch March 20, 2024 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants