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

yoda-webhook: Piggy-back GitHub reference rendering (used in > contains lists) also in > partof #35

Open
jens-markussen opened this issue Jun 25, 2023 · 1 comment

Comments

@jens-markussen
Copy link
Contributor

jens-markussen commented Jun 25, 2023

Today, issue references used in yoda-webhook are displayed differently depending if they are child- or parent references. This is because the child references area at the start of the line and thus GitHub automatically renders in different font and with an icon to show state (open/closed).

An Example:

image

This mechanism is described in the GitHub documentation here and here.

The HTML for doing this is:

Example

<span class="reference"><svg class="octicon octicon-issue-opened open mr-1" title="Open" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path d="M8 9.5a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Z"></path><path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Z"></path></svg><a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1773166129" data-permission-text="Title is private" data-url="https://github.com/jens-markussen/plan/issues/10" data-hovercard-type="issue" data-hovercard-url="/jens-markussen/plan/issues/10/hovercard" href="https://github.com/jens-markussen/plan/issues/10">Study Quantum toolkit Qskit<span class="issue-shorthand">&nbsp;#10</span></a></span>

In contract, the corresponding > partof parent link is shown as:

image

Not nearly as nice and - more importantly - inconsistant.

Would it be possible to "steal the CSS" ?

@jens-markussen
Copy link
Contributor Author

Actually, it seems that advances in GitHub issue linking (see https://docs.github.com/en/issues/tracking-your-work-with-issues/about-tasklists).

Comparing yoda-webhook to this function:

This seems to:

  • Update state of child issues. Note, the checkbox is "flaky" - not always doing it - at least if tracked by several issues.
  • Reflect that a child issue is tracked by somewhere else (even by multiple other issues)
  • Allow to have several parents (to be tracked by more than one issue), see picture below
    image

It does NOT:

  • Show easily the title of tracking issues (if you are a task of such an issue). Only see "tracked by"; then you need to hover.
  • Including set of labels to further detail the issue.
  • Have a feature akin to > issuesearch
  • Have a feature akin to > headline

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant