search

mcomella / github-issue-pr-linker

[DEPRECATED] An add-on that inserts one-click links from GitHub issues to PRs and vice versa
Other
0 stars 0 forks source link

GitHub Issue PR Linker 0.0.1 not effective? #12

Open grahamperrin opened 6 years ago

grahamperrin commented 6 years ago

From https://github.com/mcomella/github-issue-hoister#github-issue-hoister:

image

I imagined that there would be similar hoisting with GitHub Issue PR Linker, but I can't see it.

GitHub Issue PR Linker enabled, Refined GitHub disabled:

2018-06-18 21 21 27 waterfox

GitHub Issue PR Linker disabled, Refined GitHub enabled:

2018-06-18 21 21 55 waterfox

Have I misunderstood?

Suggestion

Add screenshots and (please) be more descriptive at https://addons.mozilla.org/addon/github-issue-pr-linker/

mcomella commented 6 years ago

Hey @grahamperrin - thanks for the report! I'm working on my documentation now.

The add-on extracts the issue <-> PR links from the PR titles. For example, if a PR #234 says, Closes #123: Fix readme, issue #123 will have a link to PR #234 and PR #234 will link back to issue #123. I expect this to be useful to teams that are strict about their PR naming schemes, rather than being able to use it on any GitHub repo a user comes across. I think this might be the issue you're seeing?

I'll leave this open until I'll clarify these issues in the documentation (so I don't forget to highlight how it works!) though I also have #6 open for documentation.

mcomella commented 6 years ago

I updated the README with the PR title formatting requirement and linked to it from my AMO page - I'll make a proper AMO page soon.

mcomella commented 6 years ago

I updated AMO as well. It links to a user guide, that I still need to complete, that will explain how to add a personal access token to reduce the burden of github rate limits.

@grahamperrin Let me know if these fix your issues!

grahamperrin commented 6 years ago

Thanks! From https://github.com/mcomella/github-issue-pr-linker#readme:

… a link from issue … to the PR and vice versa. …

I seem to get the in-PR link to the issue, but not vice versa. Would you like to close this, and I'll raise a fresh issue?

mcomella commented 6 years ago

I seem to get the in-PR link to the issue, but not vice versa.

Issue -> PR data requests may are triggered at most once every five minutes (I cache the data) and they're triggered by opening an issue page. It's possible you cached this data before the PR title was updated and this is why you haven't seen the data. I also don't surface rate limit errors to the user at the moment so if you're hitting rate limit errors, you just won't see the data get updated (I might console.log this).

I recognize there is a lot of nuance to using this add-on, which is difficult to communicate to users, making this a subpar experience. This is the kind of feedback I was hoping to get by start hosting this on AMO (from my teammates). :) Looking at it now, I hope to improve the documentation or add-on UI so this is clearer.

@grahamperrin Let me know if you're still having trouble.