-
Notifications
You must be signed in to change notification settings - Fork 21
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
Conversation
|
||
### 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. ---> |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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>
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
exciting stuff!
Jira Ticket: https://broadworkbench.atlassian.net/browse/UIE-162
Updated PR template to include a link to our Storybook library.