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

[UIE-162] Update template to include link to Storybook. #4743

Merged
merged 1 commit into from
Mar 27, 2024

Conversation

cahrens
Copy link
Member

@cahrens cahrens commented Mar 26, 2024

Jira Ticket: https://broadworkbench.atlassian.net/browse/UIE-162

Updated PR template to include a link to our Storybook library.

@cahrens cahrens requested review from msilva-broad and a team March 26, 2024 21:52
@cahrens cahrens marked this pull request as ready for review March 26, 2024 21:52

### Testing strategy
<!-- Note that changes impacting components in Storybook stories can be viewed at https://www.chromatic.com/library?appId=65fc89c9335768720ff8605a.
Choose the branch corresponding to this PR, and changes can be reviewed by commit. --->
Copy link
Contributor

Choose a reason for hiding this comment

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

this is a great step... maybe at a later point we can look at a way to have the correct branch already baked into the link?

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think there is a way-- when you select a branch, what gets added to the URL as a parameter is the Chromatic build number (simply an increasing integer).

Copy link
Member Author

@cahrens cahrens Mar 27, 2024

Choose a reason for hiding this comment

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

Ooooh, I was wrong! https://<branch>--65fc89c9335768720ff8605a.chromatic.com

Copy link
Contributor

Choose a reason for hiding this comment

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

It looks like the Chromatic action outputs the build URL / preview URL.

https://www.chromatic.com/docs/github-actions/#outputs

Copy link
Member Author

Choose a reason for hiding this comment

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

Cool, and there's also https://www.chromatic.com/library?appId=65fc89c9335768720ff8605a&branch=<branch>

Copy link
Contributor

Choose a reason for hiding this comment

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

Someone has made an Action to comment on the PR with a link to the preview URL.
https://github.com/dannyhw/storybook-chromatic-link-comment

If we don't want a 3rd party action, we could also add a job summary on the workflow run page.
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary

Copy link
Member Author

Choose a reason for hiding this comment

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

I was thinking that there would be a way to refer to the branch name (a variable) within the PR template. But some quick Googling shows that I am wrong.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, the PR template is static. But an Actions workflow could update the description when the PR is opened.

Copy link
Contributor

@msilva-broad msilva-broad left a comment

Choose a reason for hiding this comment

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

exciting stuff!

@cahrens cahrens added this pull request to the merge queue Mar 27, 2024
Merged via the queue into dev with commit 9014a00 Mar 27, 2024
10 checks passed
@cahrens cahrens deleted the UIE-162-template branch March 27, 2024 13:18
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.

4 participants