Gitpod's GitHub Integration feature "addComment" no longer works

[jankeromnes]

Describe the bug

When you configure your .gitpod.yml with:

github:
  prebuilds:
    addComment: true

the added comment should have a "Open/Review in Gitpod" button. But right now, it seems to have a broken image instead:

A few examples out in the wild:

• Use CUSTOM_XVFB_WxHxD for initial screen resolution workspace-images#349 (comment)
• [Full] bump go to 1.16 workspace-images#350 (comment)

This might have pushed projects to disable this feature: forem/forem@4b5622f

Steps to reproduce

1. Open a Pull Request against any project using addComment: true e.g. https://github.com/gitpod-io/workspace-images

Expected behavior

• The button image should work

Additional information

The automated comment's HTML body seems to be generated here:

gitpod/components/server/ee/src/prebuilds/github-app.ts

Line 373 in 19fb170

const body = `\n\n<a href="${this.env.hostUrl.withContext(contextURL)}"><img src="${newBadge}" /></a>\n\n`;

Maybe it's getBadgeImageURL that no longer works properly:

gitpod/components/server/ee/src/prebuilds/github-app.ts

Lines 380 to 386 in 19fb170

	protected getBadgeImageURL(cloneURL: string, commit: string): string {
	if (cloneURL.startsWith("https://")) {
	cloneURL = cloneURL.substring("https://".length);
	}
	const name = `${cloneURL}/${commit}.svg`;
	return this.env.hostUrl.withApi({ pathname: `/apps/github/pbs/${name}` }).toString();
	}

Example repository

https://github.com/gitpod-io/workspace-images/

[csweichel]

We should rather remove this functionality. It comes from a time when we didn't know how this feature should work. Closed in favour of #3303

[jankeromnes]

Re-opening this -- I think it would be cool to just fix the images while deprecation work is ongoing.

(No need for significant engineering work -- just serving some SVG should be fine).