From e247d872b148595b9aa4a3c9d0e5cbaf8225d49b Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 4 Mar 2021 12:26:42 -0500 Subject: [PATCH 1/5] Replace domain with host in temp folder Signed-off-by: Adam Harvey --- packages/techdocs-common/src/helpers.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/techdocs-common/src/helpers.ts b/packages/techdocs-common/src/helpers.ts index ec58bb7b40..be35a0b521 100644 --- a/packages/techdocs-common/src/helpers.ts +++ b/packages/techdocs-common/src/helpers.ts @@ -107,7 +107,7 @@ export const getGitRepositoryTempFolder = async ( // fs.realpathSync fixes a problem with macOS returning a path that is a symlink fs.realpathSync(os.tmpdir()), 'backstage-repo', - parsedGitLocation.source, + parsedGitLocation.resource, parsedGitLocation.owner, parsedGitLocation.name, parsedGitLocation.ref, From bb748757da61ee2ee9e663465257c672bf934ce1 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 4 Mar 2021 12:32:56 -0500 Subject: [PATCH 2/5] Improve legacy error msg Signed-off-by: Adam Harvey --- packages/techdocs-common/src/stages/prepare/commonGit.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/techdocs-common/src/stages/prepare/commonGit.ts b/packages/techdocs-common/src/stages/prepare/commonGit.ts index 46b96675f3..c38f5ced9d 100644 --- a/packages/techdocs-common/src/stages/prepare/commonGit.ts +++ b/packages/techdocs-common/src/stages/prepare/commonGit.ts @@ -40,9 +40,9 @@ export class CommonGitPreparer implements PreparerBase { options?: { etag?: string }, ): Promise { this.logger.warn( - 'You are using the legacy git preparer in TechDocs which will be removed in near future (March 2021). ' + - 'Migrate to URL reader by updating `backstage.io/techdocs-ref` annotation in `catalog-info.yaml` ' + - 'to be prefixed with `url:`. Read the migration guide and benefits at https://github.com/backstage/backstage/issues/4409 ', + `You are using the legacy git preparer in TechDocs for \`${entity.metadata.name}\` which will be removed in near future (March 2021). ` + + `Migrate to URL reader by updating \`backstage.io/techdocs-ref\` annotation in \`catalog-info.yaml\` ` + + `to be prefixed with \`url:\`. Read the migration guide and benefits at https://github.com/backstage/backstage/issues/4409 `, ); const { target } = parseReferenceAnnotation( From 56d61f36e852cbd4952d0d23af1c7e32bb529803 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 4 Mar 2021 12:37:51 -0500 Subject: [PATCH 3/5] Add changeset Signed-off-by: Adam Harvey --- .changeset/metal-trees-push.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/metal-trees-push.md diff --git a/.changeset/metal-trees-push.md b/.changeset/metal-trees-push.md new file mode 100644 index 0000000000..fee0cd7c23 --- /dev/null +++ b/.changeset/metal-trees-push.md @@ -0,0 +1,6 @@ +--- +'@backstage/techdocs-common': patch +--- + +- Improve deprecation warning messaging in logs. +- Replace temp folder path from git provider domain(`source`) to full git hostname (`resource`). (See: https://github.com/IonicaBizau/git-url-parse#giturlparseurl) From 535d4a42e6ee388a49135670d0adb42bb9a36c74 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 4 Mar 2021 12:53:40 -0500 Subject: [PATCH 4/5] Fix wording Signed-off-by: Adam Harvey --- .changeset/metal-trees-push.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/metal-trees-push.md b/.changeset/metal-trees-push.md index fee0cd7c23..f6a88c404e 100644 --- a/.changeset/metal-trees-push.md +++ b/.changeset/metal-trees-push.md @@ -3,4 +3,4 @@ --- - Improve deprecation warning messaging in logs. -- Replace temp folder path from git provider domain(`source`) to full git hostname (`resource`). (See: https://github.com/IonicaBizau/git-url-parse#giturlparseurl) +- Replace temp folder path from git provider domain(`source`) to full git host name (`resource`). (See: https://github.com/IonicaBizau/git-url-parse#giturlparseurl) From bc46435f518f5bf24772b51c458f14f6a2f4afb6 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Thu, 4 Mar 2021 14:35:54 -0500 Subject: [PATCH 5/5] Update changeset name for CODEOWNERS Signed-off-by: Adam Harvey --- .changeset/{metal-trees-push.md => techdocs-metal-trees-push.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .changeset/{metal-trees-push.md => techdocs-metal-trees-push.md} (100%) diff --git a/.changeset/metal-trees-push.md b/.changeset/techdocs-metal-trees-push.md similarity index 100% rename from .changeset/metal-trees-push.md rename to .changeset/techdocs-metal-trees-push.md