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

Set Up GitHub Actions for Publishing Storybook to GitHub Pages #130

Merged
merged 4 commits into from
Jul 21, 2021

Conversation

hreineck
Copy link
Contributor

Created gh-pages.yml in workflows
This sets up the Github actions to publish the Storybook docs
to Github pages on each push to develop.

Created gh-pages.yml in workflows
This sets up the GitHub actions to publish the Storybook docs
to GitHub pages on each push to develop.
Update the Actions in gh-pages.yml to run on a push
to EGRC-275 so that it will run properly after merging.
Copy link
Contributor

@kylelaker kylelaker left a comment

Choose a reason for hiding this comment

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

A few small changes would be good here

.github/workflows/gh-pages.yml Show resolved Hide resolved
.github/workflows/gh-pages.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@kylelaker kylelaker left a comment

Choose a reason for hiding this comment

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

Some things to talk about

.github/workflows/gh-pages.yml Show resolved Hide resolved
.github/workflows/gh-pages.yml Show resolved Hide resolved
@kylelaker
Copy link
Contributor

And as a last thing to discuss, the Action we're using has support for pushing to a different repo so that we could create a repo like oscal-react-library-storybook or something like that. We could then keep this repo's GitHub Pages clean/available for a different purpose (like deploying the sample app through GHA if we ever wanted to).

Added a TODO comment to remove `EGRC-275` from the branches
that the action is triggered on a push once this gets merged.

Removed fetch-depth 0, which would unnecessarily grab the
entire history.

Added `single-commit: true` to the deploy action, in order
to keep the commits cleaner.
Added properties to the GitHub actions for publishing Storybook
that set up a name and email for the author of the
commits made by the GitHub actions script.
@zclarkEDC
Copy link
Member

Excellent job, thank you.

@zclarkEDC zclarkEDC merged commit 4bfa4bc into EGRC-275 Jul 21, 2021
@rgauss rgauss deleted the EGRC-471 branch August 25, 2021 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants