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

Pull request preview link enhancements #371

Open
jscholes opened this issue Dec 18, 2020 · 1 comment
Open

Pull request preview link enhancements #371

jscholes opened this issue Dec 18, 2020 · 1 comment
Labels
Agenda+Community Group To discuss in the next workstream summary meeting (usually the last teleconference of the month) enhancement New feature or request github_actions Pull requests that update Github_actions code

Comments

@jscholes
Copy link
Contributor

jscholes commented Dec 18, 2020

Currently, a single "Preview Tests" link is added to the top of the pull request body, linking to the index.html page for the overall repo on a specific branch. This page displays a table of all test plans, and reviewers then have to locate the individual "Index" and "Review" page links for the pattern being reviewed on the branch.

As a potential enhancement, it would be good to link directly to both of the pattern-specific pages directly from the PR initial comment body (as I've been doing in the corresponding issues). There are some questions posed by this suggestion:

  1. How should the script executed in the GitHub action determine which test pattern is the relevant one? Is there already some machinery which marks a pattern directory as new or updated in some way to assist with this?
  2. Is it ever appropriate for a pull request and branch to include more than one new or updated pattern? For example, when the exact same component has been implemented twice, once with roving tabindex and once with aria-activedescendant, wouldn't it just create noise and duplicated work to file multiple PRs when the majority of test data is the same?
  3. If the answer to point #2 is yes, how should this be handled when generating deep preview links?
  4. Should there be a link on all individual pattern index and review pages to return to index.html, just in case?
  5. What should the behaviour be when a PR is submitted which doesn't relate to a specific pattern, but to some shared infrastructure instead?
@jscholes jscholes added enhancement New feature or request Agenda+Community Group To discuss in the next workstream summary meeting (usually the last teleconference of the month) github_actions Pull requests that update Github_actions code labels Dec 18, 2020
@mcking65
Copy link
Contributor

Perhaps we have some syntax in the PR comment that enables the PR author to specify what preview links are needed and their pattern targets?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Agenda+Community Group To discuss in the next workstream summary meeting (usually the last teleconference of the month) enhancement New feature or request github_actions Pull requests that update Github_actions code
Projects
None yet
Development

No branches or pull requests

2 participants