Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Deploy Storybook to GitHub pages #550

Merged
merged 6 commits into from
Dec 24, 2021
Merged

Deploy Storybook to GitHub pages #550

merged 6 commits into from
Dec 24, 2021

Conversation

sarayourfriend
Copy link
Contributor

@sarayourfriend sarayourfriend commented Dec 22, 2021

Fixes

Fixes #549 by @sarayourfriend

Description

Sets up the necessary stuff to deploy Storybook from the gh-pages branch by adding a new workflow for pushing to that branch on merge to main.

Testing Instructions

Let the CI run on this PR and then check the gh-pages branch and verify that it's been created and updated.\

You can also see the currently deployed version from cb81806 here: https://wordpress.github.io/openverse-frontend - after that commit I removed the testing code that was pushing to the gh-pages branch in this PR. From now on it will only run on merge to main.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • [N/A] I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@sarayourfriend sarayourfriend added 🟩 priority: low Low priority and doesn't need to be rushed 🌟 goal: addition Addition of new feature 🤖 aspect: dx Concerns developers' experience with the codebase labels Dec 22, 2021
@sarayourfriend sarayourfriend requested a review from a team as a code owner December 22, 2021 21:12
@dhruvkb
Copy link
Member

dhruvkb commented Dec 22, 2021

I understand it's a bit unrelated to this PR but I'd love to have something that provides a deployment URL for every PR, similar to how Netlify and Vercel are able to do. It'll make testing PRs with UI changes so much easier.

@sarayourfriend
Copy link
Contributor Author

I understand it's a bit unrelated to this PR but I'd love to have something that provides a deployment URL for every PR, similar to how Netlify and Vercel are able to do. It'll make testing PRs with UI changes so much easier.

100% on board with that Dhruv! I'll ask around and see if anyone has opinions on how to get that done. I know it's something that the Gutenberg folks have talked about before so I'm sure they have some existing ideas about it.

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

LGTM! Would love to see it live!

README.md Outdated Show resolved Hide resolved
.github/workflows/gh-pages.yaml Outdated Show resolved Hide resolved
sarayourfriend and others added 2 commits December 23, 2021 06:05
Co-authored-by: Dhruv Bhanushali <dhruv_b@live.com>
Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

So cool to have the Storybook deployed on the main branch! :)

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Really useful addition!

@sarayourfriend sarayourfriend merged commit a70349f into main Dec 24, 2021
@sarayourfriend sarayourfriend deleted the add/gh-pages branch December 24, 2021 03:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🌟 goal: addition Addition of new feature 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deploy Storybook to GitHub pages
4 participants