paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 20 Packages Projects Releases Wiki Activity

Merge pull request #6880 from kuangp/fix/feedbackUrl

Browse Source 
fix(techdocs): generate correct feedback urls for GitHub
This commit is contained in:
Fredrik Adelöw
2021-08-25 15:26:34 +02:00
committed by GitHub
parent e403695599 90c68a2ca8
commit 3c14f71b08
6 changed files with 35 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs/src/reader/transformers/addGitFeedbackLink.test.ts
+2 -2
View File
@@ -85,7 +85,7 @@ describe('addGitFeedbackLink', () => {
<html>
<article class="md-content__inner">
<h1>HeaderText</h1>
<a title="Edit this page" href="https://github.com/groupname/reponame/blob/master/docs/docname.md"></>
<a title="Edit this page" href="https://github.com/groupname/reponame/edit/master/docs/docname.md"></>
</article>
</html>
`,
@@ -99,7 +99,7 @@ describe('addGitFeedbackLink', () => {
expect(
(shadowDom.querySelector('#git-feedback-link') as HTMLLinkElement)!.href,
).toEqual(
'https://github.com/groupname/reponame/issues/new?title=Documentation%20Feedback%3A%20HeaderText&body=Page%20source%3A%0Ahttps%3A%2F%2Fgithub.com%2Fgroupname%2Freponame%2Fblob%2Fmaster%2Fdocs%2Fdocname.md%0A%0AFeedback%3A',
'https://github.com/groupname/reponame/issues/new?title=Documentation%20Feedback%3A%20HeaderText&body=Page%20source%3A%0Ahttps%3A%2F%2Fgithub.com%2Fgroupname%2Freponame%2Fedit%2Fmaster%2Fdocs%2Fdocname.md%0A%0AFeedback%3A',
);
});
plugins/techdocs/src/reader/transformers/addGitFeedbackLink.ts
+11 -2
View File
@@ -15,7 +15,10 @@
*/
import type { Transformer } from './index';
import { ScmIntegrationRegistry } from '@backstage/integration';
import {
replaceGitHubUrlType,
ScmIntegrationRegistry,
} from '@backstage/integration';
import FeedbackOutlinedIcon from '@material-ui/icons/FeedbackOutlined';
import React from 'react';
import ReactDOM from 'react-dom';
@@ -51,7 +54,13 @@ export const addGitFeedbackLink = (
const issueDesc = encodeURIComponent(
`Page source:\n${sourceAnchor.href}\n\nFeedback:`,
);
const gitInfo = parseGitUrl(sourceURL.pathname);
// Convert GitHub edit url to blob type so it can be parsed by git-url-parse correctly
const gitUrl =
integration?.type === 'github'
? replaceGitHubUrlType(sourceURL.href, 'blob')
: sourceURL.href;
const gitInfo = parseGitUrl(gitUrl);
const repoPath = `/${gitInfo.organization}/${gitInfo.name}`;
const feedbackLink = sourceAnchor.cloneNode() as HTMLAnchorElement;