From acf6c8c10b2c9f5206456f3216280019a00e3df6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20=C5=A0neberger?= Date: Mon, 6 Feb 2023 13:49:48 +0100 Subject: [PATCH 1/9] [TechRadar] Deprecate RadarEntry.url MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Šneberger --- .changeset/hip-chairs-double.md | 5 +++++ .changeset/slow-moles-sin.md | 2 +- plugins/tech-radar/src/api.ts | 2 ++ 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 .changeset/hip-chairs-double.md diff --git a/.changeset/hip-chairs-double.md b/.changeset/hip-chairs-double.md new file mode 100644 index 0000000000..73e939ba21 --- /dev/null +++ b/.changeset/hip-chairs-double.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-tech-radar': minor +--- + +Deprecate `RadarEntry.url` - use `RadarEntry.links` instead diff --git a/.changeset/slow-moles-sin.md b/.changeset/slow-moles-sin.md index 140d9e7435..02e1952312 100644 --- a/.changeset/slow-moles-sin.md +++ b/.changeset/slow-moles-sin.md @@ -2,4 +2,4 @@ '@backstage/plugin-circleci': patch --- -Making workflow a link +Making workflow a link diff --git a/plugins/tech-radar/src/api.ts b/plugins/tech-radar/src/api.ts index 0fbc88255a..bf90cf0750 100644 --- a/plugins/tech-radar/src/api.ts +++ b/plugins/tech-radar/src/api.ts @@ -133,6 +133,8 @@ export interface RadarEntry { * @remarks * * You can use `#` if you don't want to provide any other url + * + * @deprecated Use {@link RadarEntry.links} instead */ url: string; /** From 9a58b4127e6a4a5fad3000a84aa71135fa40ca13 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20=C5=A0neberger?= Date: Mon, 6 Feb 2023 14:17:47 +0100 Subject: [PATCH 2/9] Build API report MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Šneberger --- plugins/tech-radar/api-report.md | 1 + 1 file changed, 1 insertion(+) diff --git a/plugins/tech-radar/api-report.md b/plugins/tech-radar/api-report.md index e2744872d8..2836e04461 100644 --- a/plugins/tech-radar/api-report.md +++ b/plugins/tech-radar/api-report.md @@ -25,6 +25,7 @@ export interface RadarEntry { quadrant: string; timeline: Array; title: string; + // @deprecated url: string; } From 4382e0c7a2ce78db27d668d936f5c3aae41d286d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20=C5=A0neberger?= Date: Mon, 6 Feb 2023 15:24:33 +0100 Subject: [PATCH 3/9] Remove deprecated url from `sample.ts` MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Šneberger --- plugins/tech-radar/src/sample.ts | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/plugins/tech-radar/src/sample.ts b/plugins/tech-radar/src/sample.ts index 1c4f7a1a01..0dc647ac54 100644 --- a/plugins/tech-radar/src/sample.ts +++ b/plugins/tech-radar/src/sample.ts @@ -45,12 +45,16 @@ entries.push({ 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua', }, ], - url: 'https://www.javascript.com/', + url: '#', key: 'javascript', id: 'javascript', title: 'JavaScript', quadrant: 'languages', links: [ + { + url: 'https://www.javascript.com/', + title: 'Learn more', + }, { url: 'https://www.typescriptlang.org/', title: 'TypeScript', @@ -87,7 +91,13 @@ entries.push({ 'Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur', }, ], - url: 'https://webpack.js.org/', + url: '#', + links: [ + { + url: 'https://webpack.js.org/', + title: 'Learn more', + }, + ], key: 'webpack', id: 'webpack', title: 'Webpack', @@ -101,7 +111,13 @@ entries.push({ date: new Date('2020-08-06'), }, ], - url: 'https://reactjs.org/', + url: '#', + links: [ + { + url: 'https://reactjs.org/', + title: 'Learn more', + }, + ], key: 'react', id: 'react', title: 'React', @@ -170,7 +186,13 @@ entries.push({ description: 'long description', }, ], - url: 'https://github.com', + url: '#', + links: [ + { + url: 'https://reactjs.org/', + title: 'Learn more', + }, + ], key: 'github-actions', id: 'github-actions', title: 'GitHub Actions', From 5b5d7d416ffca72ce84d0bf844a3938a9aacf777 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20=C5=A0neberger?= Date: Mon, 6 Feb 2023 15:27:22 +0100 Subject: [PATCH 4/9] Update changeset with migration diff MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Šneberger --- .changeset/hip-chairs-double.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/.changeset/hip-chairs-double.md b/.changeset/hip-chairs-double.md index 73e939ba21..722795d80d 100644 --- a/.changeset/hip-chairs-double.md +++ b/.changeset/hip-chairs-double.md @@ -3,3 +3,18 @@ --- Deprecate `RadarEntry.url` - use `RadarEntry.links` instead + +```diff +- url: 'https://www.javascript.com/', ++ url: '#', + key: 'javascript', + id: 'javascript', + title: 'JavaScript', + quadrant: 'languages', + links: [ ++ { ++ url: 'https://www.javascript.com/', ++ title: 'Learn more', ++ }, + ], +``` From 0d0cb65e5e4ae7cde89a444a236433abf099d22f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20=C5=A0neberger?= Date: Mon, 6 Feb 2023 19:08:21 +0100 Subject: [PATCH 5/9] Release this change as a patch version MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Šneberger --- .changeset/hip-chairs-double.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/hip-chairs-double.md b/.changeset/hip-chairs-double.md index 722795d80d..52cdde3588 100644 --- a/.changeset/hip-chairs-double.md +++ b/.changeset/hip-chairs-double.md @@ -1,5 +1,5 @@ --- -'@backstage/plugin-tech-radar': minor +'@backstage/plugin-tech-radar': patch --- Deprecate `RadarEntry.url` - use `RadarEntry.links` instead From 5b9a1e7dc00a25f474162b73ba606673df23eefc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20=C5=A0neberger?= Date: Mon, 6 Feb 2023 19:16:04 +0100 Subject: [PATCH 6/9] Make RadarEntry.url optional MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Šneberger --- plugins/tech-radar/api-report.md | 2 +- plugins/tech-radar/src/api.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/tech-radar/api-report.md b/plugins/tech-radar/api-report.md index 2836e04461..3b84990d85 100644 --- a/plugins/tech-radar/api-report.md +++ b/plugins/tech-radar/api-report.md @@ -26,7 +26,7 @@ export interface RadarEntry { timeline: Array; title: string; // @deprecated - url: string; + url?: string; } // @public diff --git a/plugins/tech-radar/src/api.ts b/plugins/tech-radar/src/api.ts index bf90cf0750..c0b8fb8852 100644 --- a/plugins/tech-radar/src/api.ts +++ b/plugins/tech-radar/src/api.ts @@ -136,7 +136,7 @@ export interface RadarEntry { * * @deprecated Use {@link RadarEntry.links} instead */ - url: string; + url?: string; /** * History of the Entry moving through {@link RadarRing} */ From 8060b73e5ed74f053289df62717264f2fd588564 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20=C5=A0neberger?= Date: Mon, 6 Feb 2023 19:16:27 +0100 Subject: [PATCH 7/9] Remove deprecated url attribute from sample MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Šneberger --- plugins/tech-radar/src/sample.ts | 9 --------- 1 file changed, 9 deletions(-) diff --git a/plugins/tech-radar/src/sample.ts b/plugins/tech-radar/src/sample.ts index 0dc647ac54..1a6f372f64 100644 --- a/plugins/tech-radar/src/sample.ts +++ b/plugins/tech-radar/src/sample.ts @@ -45,7 +45,6 @@ entries.push({ 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua', }, ], - url: '#', key: 'javascript', id: 'javascript', title: 'JavaScript', @@ -73,7 +72,6 @@ entries.push({ 'Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat', }, ], - url: '#', key: 'typescript', id: 'typescript', title: 'TypeScript', @@ -91,7 +89,6 @@ entries.push({ 'Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur', }, ], - url: '#', links: [ { url: 'https://webpack.js.org/', @@ -111,7 +108,6 @@ entries.push({ date: new Date('2020-08-06'), }, ], - url: '#', links: [ { url: 'https://reactjs.org/', @@ -131,7 +127,6 @@ entries.push({ date: new Date('2020-08-06'), }, ], - url: '#', key: 'code-reviews', id: 'code-reviews', title: 'Code Reviews', @@ -145,7 +140,6 @@ entries.push({ date: new Date('2020-08-06'), }, ], - url: '#', key: 'mob-programming', id: 'mob-programming', title: 'Mob Programming', @@ -159,7 +153,6 @@ entries.push({ date: new Date('2020-08-06'), }, ], - url: '#', key: 'docs-like-code', id: 'docs-like-code', title: 'Docs-like-code', @@ -172,7 +165,6 @@ entries.push({ date: new Date('2020-08-06'), }, ], - url: '#', key: 'force-push', id: 'force-push', title: 'Force push to master', @@ -186,7 +178,6 @@ entries.push({ description: 'long description', }, ], - url: '#', links: [ { url: 'https://reactjs.org/', From 8784b505af2ccef161a479ce3b099468e8c45a2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20=C5=A0neberger?= Date: Mon, 6 Feb 2023 19:17:51 +0100 Subject: [PATCH 8/9] Remove url attribute from the diff MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Šneberger --- .changeset/hip-chairs-double.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.changeset/hip-chairs-double.md b/.changeset/hip-chairs-double.md index 52cdde3588..e2b03f2e66 100644 --- a/.changeset/hip-chairs-double.md +++ b/.changeset/hip-chairs-double.md @@ -6,7 +6,6 @@ Deprecate `RadarEntry.url` - use `RadarEntry.links` instead ```diff - url: 'https://www.javascript.com/', -+ url: '#', key: 'javascript', id: 'javascript', title: 'JavaScript', From 67ebd7f8a576638d34d37e184efc0abd6a2cfb34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20=C5=A0neberger?= Date: Mon, 6 Feb 2023 19:45:14 +0100 Subject: [PATCH 9/9] Fix URL MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marek Šneberger --- plugins/tech-radar/src/sample.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/tech-radar/src/sample.ts b/plugins/tech-radar/src/sample.ts index 1a6f372f64..395b4f2ff5 100644 --- a/plugins/tech-radar/src/sample.ts +++ b/plugins/tech-radar/src/sample.ts @@ -180,7 +180,7 @@ entries.push({ ], links: [ { - url: 'https://reactjs.org/', + url: 'https://github.com', title: 'Learn more', }, ],