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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 1 commit into from
Mar 27, 2024
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@
<!--Please give an abridged version of the ticket description here and/or fill out the following fields.-->

### What
-
-

### Why
-
-

### 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 •
edited
Loading

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.


- [ ] <!-- Test case 1 -->

<!-- ### Visual Aids -->
<!-- https://support.apple.com/guide/quicktime-player/record-your-screen-qtp97b08e666/mac -->
<!-- https://support.apple.com/guide/quicktime-player/record-your-screen-qtp97b08e666/mac -->
Loading