PR review companion adds noisy GitHub links between issues and PRs

[bsmth]

On each new pull request, the PR companion leaves a comment with preview URLs. One of the features of the comment is a list of external links in each docs page. This has the unintended side effect that PRs will be linked on GitHub.com, even if the PR content / motivation is unrelated.

Example outcome:

Check https://github.com/httpwg/http-core/issues/26 for example. Have a look at the occurrences of [github-actions](https://github.com/apps/github-actions) bot mentioned this issue events. This HTTPWG issue is referenced in prose in a docs page. Every PR that modifies this page creates a link back to the PR because of the bot preview URLs comment. In most cases, this is not helpful.

Suggestion:

Consider wrapping github.com/*/*/pulls/[0-9]+ and github.com/*/*/issues/[0-9]+ links in backticks instead of allowing the raw URLs to be passed through.

Problem area:

yari/deployer/src/deployer/analyze_pr.py

Lines 162 to 176 in 450e433

	if external_urls:
	external_urls_list = []
	for url in sorted(external_urls):
	count = external_urls[url]
	line = (
	f" - {'🚨 ' if url.startswith('http://') else ''}"
	f"<{url}> ({count} time{'' if count==1 else 's'})"
	)
	if diff_lines:
	# If this was available and it _did_ fine a URL, then
	# really make sure it's noticed.
	line += " (Note! This may be a new URL 👀)"
	external_urls_list.append(line)
	comments.append((doc, "\n".join(external_urls_list)))
	total_urls += len(external_urls_list)

[Josh-Cena]

Consider using redirect.github.com: https://redirect.github.com/httpwg/http-core/issues/26. It links to the same page but does not create a issue reference.