From eea0849d6b4f1761e0cf1c16e6ff5e896510b603 Mon Sep 17 00:00:00 2001 From: Craig Tracey Date: Tue, 26 Dec 2023 23:08:38 -0500 Subject: [PATCH 1/6] Add a user-settings core nav item As user-settings should show up in the core nav, add a user-settings nav item to the declarative integration plugin. Signed-off-by: Craig Tracey --- .changeset/chilled-zebras-wash.md | 5 +++++ plugins/user-settings/api-report-alpha.md | 6 ++++++ plugins/user-settings/src/alpha.tsx | 11 ++++++++++- 3 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 .changeset/chilled-zebras-wash.md diff --git a/.changeset/chilled-zebras-wash.md b/.changeset/chilled-zebras-wash.md new file mode 100644 index 0000000000..9597915ce5 --- /dev/null +++ b/.changeset/chilled-zebras-wash.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-user-settings': patch +--- + +add user-settings declarative integration core nav item diff --git a/plugins/user-settings/api-report-alpha.md b/plugins/user-settings/api-report-alpha.md index adb609a2cb..b06fd1e583 100644 --- a/plugins/user-settings/api-report-alpha.md +++ b/plugins/user-settings/api-report-alpha.md @@ -4,6 +4,7 @@ ```ts import { BackstagePlugin } from '@backstage/frontend-plugin-api'; +import { ExtensionDefinition } from '@backstage/frontend-plugin-api'; import { RouteRef } from '@backstage/frontend-plugin-api'; import { TranslationRef } from '@backstage/core-plugin-api/alpha'; @@ -16,6 +17,11 @@ const _default: BackstagePlugin< >; export default _default; +// @alpha (undocumented) +export const settingsNavItem: ExtensionDefinition<{ + title: string; +}>; + // @alpha (undocumented) export const userSettingsTranslationRef: TranslationRef< 'user-settings', diff --git a/plugins/user-settings/src/alpha.tsx b/plugins/user-settings/src/alpha.tsx index 06590d839a..5dabd70739 100644 --- a/plugins/user-settings/src/alpha.tsx +++ b/plugins/user-settings/src/alpha.tsx @@ -16,6 +16,7 @@ import { coreExtensionData, createExtensionInput, + createNavItemExtension, createPageExtension, createPlugin, } from '@backstage/frontend-plugin-api'; @@ -23,6 +24,7 @@ import { convertLegacyRouteRef, compatWrapper, } from '@backstage/core-compat-api'; +import SettingsIcon from '@material-ui/icons/Settings'; import { settingsRouteRef } from './plugin'; import React from 'react'; @@ -50,12 +52,19 @@ const userSettingsPage = createPageExtension({ ), }); +/** @alpha */ +export const settingsNavItem = createNavItemExtension({ + routeRef: convertLegacyRouteRef(settingsRouteRef), + title: 'Settings', + icon: SettingsIcon, +}); + /** * @alpha */ export default createPlugin({ id: 'user-settings', - extensions: [userSettingsPage], + extensions: [userSettingsPage, settingsNavItem], routes: { root: convertLegacyRouteRef(settingsRouteRef), }, From 5087e585e1ee1a5cfc3269f4a90fb0d338af787b Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Wed, 3 Jan 2024 15:11:43 +0000 Subject: [PATCH 2/6] chore(deps): update dependency esbuild to v0.19.11 Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- yarn.lock | 190 +++++++++++++++++++++++++++--------------------------- 1 file changed, 95 insertions(+), 95 deletions(-) diff --git a/yarn.lock b/yarn.lock index 954435a662..b812449084 100644 --- a/yarn.lock +++ b/yarn.lock @@ -10466,9 +10466,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/aix-ppc64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/aix-ppc64@npm:0.19.10" +"@esbuild/aix-ppc64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/aix-ppc64@npm:0.19.11" conditions: os=aix & cpu=ppc64 languageName: node linkType: hard @@ -10487,9 +10487,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/android-arm64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/android-arm64@npm:0.19.10" +"@esbuild/android-arm64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/android-arm64@npm:0.19.11" conditions: os=android & cpu=arm64 languageName: node linkType: hard @@ -10508,9 +10508,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/android-arm@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/android-arm@npm:0.19.10" +"@esbuild/android-arm@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/android-arm@npm:0.19.11" conditions: os=android & cpu=arm languageName: node linkType: hard @@ -10529,9 +10529,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/android-x64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/android-x64@npm:0.19.10" +"@esbuild/android-x64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/android-x64@npm:0.19.11" conditions: os=android & cpu=x64 languageName: node linkType: hard @@ -10550,9 +10550,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/darwin-arm64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/darwin-arm64@npm:0.19.10" +"@esbuild/darwin-arm64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/darwin-arm64@npm:0.19.11" conditions: os=darwin & cpu=arm64 languageName: node linkType: hard @@ -10571,9 +10571,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/darwin-x64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/darwin-x64@npm:0.19.10" +"@esbuild/darwin-x64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/darwin-x64@npm:0.19.11" conditions: os=darwin & cpu=x64 languageName: node linkType: hard @@ -10592,9 +10592,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/freebsd-arm64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/freebsd-arm64@npm:0.19.10" +"@esbuild/freebsd-arm64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/freebsd-arm64@npm:0.19.11" conditions: os=freebsd & cpu=arm64 languageName: node linkType: hard @@ -10613,9 +10613,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/freebsd-x64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/freebsd-x64@npm:0.19.10" +"@esbuild/freebsd-x64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/freebsd-x64@npm:0.19.11" conditions: os=freebsd & cpu=x64 languageName: node linkType: hard @@ -10634,9 +10634,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/linux-arm64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/linux-arm64@npm:0.19.10" +"@esbuild/linux-arm64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/linux-arm64@npm:0.19.11" conditions: os=linux & cpu=arm64 languageName: node linkType: hard @@ -10655,9 +10655,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/linux-arm@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/linux-arm@npm:0.19.10" +"@esbuild/linux-arm@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/linux-arm@npm:0.19.11" conditions: os=linux & cpu=arm languageName: node linkType: hard @@ -10676,9 +10676,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/linux-ia32@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/linux-ia32@npm:0.19.10" +"@esbuild/linux-ia32@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/linux-ia32@npm:0.19.11" conditions: os=linux & cpu=ia32 languageName: node linkType: hard @@ -10697,9 +10697,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/linux-loong64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/linux-loong64@npm:0.19.10" +"@esbuild/linux-loong64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/linux-loong64@npm:0.19.11" conditions: os=linux & cpu=loong64 languageName: node linkType: hard @@ -10718,9 +10718,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/linux-mips64el@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/linux-mips64el@npm:0.19.10" +"@esbuild/linux-mips64el@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/linux-mips64el@npm:0.19.11" conditions: os=linux & cpu=mips64el languageName: node linkType: hard @@ -10739,9 +10739,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/linux-ppc64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/linux-ppc64@npm:0.19.10" +"@esbuild/linux-ppc64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/linux-ppc64@npm:0.19.11" conditions: os=linux & cpu=ppc64 languageName: node linkType: hard @@ -10760,9 +10760,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/linux-riscv64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/linux-riscv64@npm:0.19.10" +"@esbuild/linux-riscv64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/linux-riscv64@npm:0.19.11" conditions: os=linux & cpu=riscv64 languageName: node linkType: hard @@ -10781,9 +10781,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/linux-s390x@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/linux-s390x@npm:0.19.10" +"@esbuild/linux-s390x@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/linux-s390x@npm:0.19.11" conditions: os=linux & cpu=s390x languageName: node linkType: hard @@ -10802,9 +10802,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/linux-x64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/linux-x64@npm:0.19.10" +"@esbuild/linux-x64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/linux-x64@npm:0.19.11" conditions: os=linux & cpu=x64 languageName: node linkType: hard @@ -10823,9 +10823,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/netbsd-x64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/netbsd-x64@npm:0.19.10" +"@esbuild/netbsd-x64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/netbsd-x64@npm:0.19.11" conditions: os=netbsd & cpu=x64 languageName: node linkType: hard @@ -10844,9 +10844,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/openbsd-x64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/openbsd-x64@npm:0.19.10" +"@esbuild/openbsd-x64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/openbsd-x64@npm:0.19.11" conditions: os=openbsd & cpu=x64 languageName: node linkType: hard @@ -10865,9 +10865,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/sunos-x64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/sunos-x64@npm:0.19.10" +"@esbuild/sunos-x64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/sunos-x64@npm:0.19.11" conditions: os=sunos & cpu=x64 languageName: node linkType: hard @@ -10886,9 +10886,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/win32-arm64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/win32-arm64@npm:0.19.10" +"@esbuild/win32-arm64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/win32-arm64@npm:0.19.11" conditions: os=win32 & cpu=arm64 languageName: node linkType: hard @@ -10907,9 +10907,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/win32-ia32@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/win32-ia32@npm:0.19.10" +"@esbuild/win32-ia32@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/win32-ia32@npm:0.19.11" conditions: os=win32 & cpu=ia32 languageName: node linkType: hard @@ -10928,9 +10928,9 @@ __metadata: languageName: node linkType: hard -"@esbuild/win32-x64@npm:0.19.10": - version: 0.19.10 - resolution: "@esbuild/win32-x64@npm:0.19.10" +"@esbuild/win32-x64@npm:0.19.11": + version: 0.19.11 + resolution: "@esbuild/win32-x64@npm:0.19.11" conditions: os=win32 & cpu=x64 languageName: node linkType: hard @@ -25673,32 +25673,32 @@ __metadata: linkType: hard "esbuild@npm:^0.19.0": - version: 0.19.10 - resolution: "esbuild@npm:0.19.10" + version: 0.19.11 + resolution: "esbuild@npm:0.19.11" dependencies: - "@esbuild/aix-ppc64": 0.19.10 - "@esbuild/android-arm": 0.19.10 - "@esbuild/android-arm64": 0.19.10 - "@esbuild/android-x64": 0.19.10 - "@esbuild/darwin-arm64": 0.19.10 - "@esbuild/darwin-x64": 0.19.10 - "@esbuild/freebsd-arm64": 0.19.10 - "@esbuild/freebsd-x64": 0.19.10 - "@esbuild/linux-arm": 0.19.10 - "@esbuild/linux-arm64": 0.19.10 - "@esbuild/linux-ia32": 0.19.10 - "@esbuild/linux-loong64": 0.19.10 - "@esbuild/linux-mips64el": 0.19.10 - "@esbuild/linux-ppc64": 0.19.10 - "@esbuild/linux-riscv64": 0.19.10 - "@esbuild/linux-s390x": 0.19.10 - "@esbuild/linux-x64": 0.19.10 - "@esbuild/netbsd-x64": 0.19.10 - "@esbuild/openbsd-x64": 0.19.10 - "@esbuild/sunos-x64": 0.19.10 - "@esbuild/win32-arm64": 0.19.10 - "@esbuild/win32-ia32": 0.19.10 - "@esbuild/win32-x64": 0.19.10 + "@esbuild/aix-ppc64": 0.19.11 + "@esbuild/android-arm": 0.19.11 + "@esbuild/android-arm64": 0.19.11 + "@esbuild/android-x64": 0.19.11 + "@esbuild/darwin-arm64": 0.19.11 + "@esbuild/darwin-x64": 0.19.11 + "@esbuild/freebsd-arm64": 0.19.11 + "@esbuild/freebsd-x64": 0.19.11 + "@esbuild/linux-arm": 0.19.11 + "@esbuild/linux-arm64": 0.19.11 + "@esbuild/linux-ia32": 0.19.11 + "@esbuild/linux-loong64": 0.19.11 + "@esbuild/linux-mips64el": 0.19.11 + "@esbuild/linux-ppc64": 0.19.11 + "@esbuild/linux-riscv64": 0.19.11 + "@esbuild/linux-s390x": 0.19.11 + "@esbuild/linux-x64": 0.19.11 + "@esbuild/netbsd-x64": 0.19.11 + "@esbuild/openbsd-x64": 0.19.11 + "@esbuild/sunos-x64": 0.19.11 + "@esbuild/win32-arm64": 0.19.11 + "@esbuild/win32-ia32": 0.19.11 + "@esbuild/win32-x64": 0.19.11 dependenciesMeta: "@esbuild/aix-ppc64": optional: true @@ -25748,7 +25748,7 @@ __metadata: optional: true bin: esbuild: bin/esbuild - checksum: b97f2f837c931e065839fe9adebba44b80aaa81c6b32dca4e1e77c068a0afb045d08a94d86abdacb29daef783ec092f0db688a31f3d463e2e42ac17e5a478265 + checksum: ae949a796d1d06b55275ae7491ce137857468f69a93d8cc9c0943d2a701ac54e14dbb250a2ba56f2ad98283669578f1ec3bd85a4681910a5ff29a2470c3bd62c languageName: node linkType: hard From b327d39483828495e4a19e326da31943b10771be Mon Sep 17 00:00:00 2001 From: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Date: Thu, 4 Jan 2024 10:39:12 -0600 Subject: [PATCH 3/6] Revert "[GitHub Issue Templates] Removed placeholder and moved text to description" Signed-off-by: Andre Wanlin --- .github/ISSUE_TEMPLATE/bug.yaml | 21 ++++++++++++++------- .github/ISSUE_TEMPLATE/feature.yaml | 5 ++++- .github/ISSUE_TEMPLATE/plugin.yaml | 5 ++++- .github/ISSUE_TEMPLATE/rfc.yaml | 12 ++++++++---- .github/ISSUE_TEMPLATE/ux_component.yaml | 13 ++++++++----- 5 files changed, 38 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 356faa81ea..57595621e4 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -13,29 +13,33 @@ body: required: true attributes: label: '๐Ÿ“œ Description' - description: 'A clear and concise description of what the bug is. It bugs out when ...' + description: 'A clear and concise description of what the bug is.' + placeholder: 'It bugs out when ...' - type: textarea id: expected-behavior validations: required: true attributes: label: '๐Ÿ‘ Expected behavior' - description: 'What did you think should happen? It should ...' + description: 'What did you think should happen?' + placeholder: 'It should ...' - type: textarea id: actual-behavior validations: required: true attributes: label: '๐Ÿ‘Ž Actual Behavior with Screenshots' - description: 'What did actually happen? Add screenshots, if applicable. It actually ...' + description: 'What did actually happen? Add screenshots, if applicable.' + placeholder: 'It actually ...' - type: textarea id: steps-to-reproduce validations: required: true attributes: label: '๐Ÿ‘Ÿ Reproduction steps' - description: 'How do you trigger this bug? Please walk us through it step by step. Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code or configuration to reproduce, if relevant.' - placeholder: "\n + description: 'How do you trigger this bug? Please walk us through it step by step.' + placeholder: + "Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code or configuration to reproduce, if relevant.\n 1. Go to '...'\n 2. Click on '....'\n 3. Scroll down to '....'" @@ -45,14 +49,17 @@ body: required: false attributes: label: '๐Ÿ“ƒ Provide the context for the Bug.' - description: 'How has this issue affected you? What are you trying to accomplish? Providing context (e.g. links to configuration settings, stack trace or log data) helps us come up with a solution that is most useful in the real world.' + description: 'How has this issue affected you? What are you trying to accomplish?' + placeholder: 'Providing context (e.g. links to configuration settings, stack trace or log data) helps us come up with a solution that is most useful in the real world.' - type: textarea id: environment validations: required: false attributes: label: '๐Ÿ–ฅ๏ธ Your Environment' - description: 'Always provide output of `yarn backstage-cli info`; provide browser information when applicable. Include as many relevant details about the environment you experienced the bug in.' + description: 'Provide Browser Information + Provide Output of `yarn backstage-cli info`' + placeholder: 'Include as many relevant details about the environment you experienced the bug in.' - type: checkboxes id: no-duplicate-issues attributes: diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml index 8b1a697351..b2d5a6be81 100644 --- a/.github/ISSUE_TEMPLATE/feature.yaml +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -14,6 +14,7 @@ body: attributes: label: '๐Ÿ”– Feature description' description: 'A clear and concise description of what the feature is.' + placeholder: 'You should add ...' - type: textarea id: context validations: @@ -21,11 +22,13 @@ body: attributes: label: '๐ŸŽค Context' description: 'Please explain why this feature should be implemented and how it would be used. Add examples, if applicable.' + placeholder: 'In my use-case, ...' - type: textarea id: implementation attributes: label: 'โœŒ๏ธ Possible Implementation' - description: 'A clear and concise description of what you want to happen. Not obligatory, but ideas as to the implementation of the addition or change.' + description: 'A clear and concise description of what you want to happen.' + placeholder: 'Not obligatory, but ideas as to the implementation of the addition or change' - type: checkboxes id: no-duplicate-issues attributes: diff --git a/.github/ISSUE_TEMPLATE/plugin.yaml b/.github/ISSUE_TEMPLATE/plugin.yaml index f77076146c..a7f5216631 100644 --- a/.github/ISSUE_TEMPLATE/plugin.yaml +++ b/.github/ISSUE_TEMPLATE/plugin.yaml @@ -14,16 +14,19 @@ body: attributes: label: '๐Ÿ”– Summary' description: 'Provide a general summary of the plugin and how it should work' + placeholder: 'You should add ...' - type: textarea id: website attributes: label: '๐ŸŒ Project website (if applicable)' description: 'Add a link to the open source project or product this plugin will integrate with, if existing' + placeholder: 'Website Link is ...' - type: textarea id: context attributes: label: 'โœŒ๏ธ Context' - description: 'A clear and concise description about the Plugin and any additional context.' + description: 'A clear and concise description about the Plugin.' + placeholder: 'Providing additional context' - type: checkboxes id: no-duplicate-issues attributes: diff --git a/.github/ISSUE_TEMPLATE/rfc.yaml b/.github/ISSUE_TEMPLATE/rfc.yaml index eae85419e7..8e73992dc8 100644 --- a/.github/ISSUE_TEMPLATE/rfc.yaml +++ b/.github/ISSUE_TEMPLATE/rfc.yaml @@ -13,24 +13,28 @@ body: required: true attributes: label: '๐Ÿ”– Need' - description: "Let us know why are you proposing this change. The problem we're trying to address and the benefits/impact we expect to get from this are ..." + description: 'Let us know why are you proposing this change' + placeholder: 'The problem weโ€™re trying to address and the benefits/impact we expect to get from this are ...' - type: textarea id: proposal validations: required: true attributes: label: '๐ŸŽ‰ Proposal' - description: 'Describe the proposal in as much detail as needed for reviewers to give concrete feedback. Take special care in this section to describe any implications on data privacy or security.' + description: 'Describe the proposal in as much detail as needed for reviewers to give concrete feedback.' + placeholder: 'Take special care in this section to describe any implications on data privacy or security.' - type: textarea id: alternatives attributes: label: 'ใ€ฝ๏ธ Alternatives' - description: 'What alternatives to the proposed solution were considered? What criteria/data was used to discard these?' + description: 'What alternatives to the proposed solution were considered?' + placeholder: 'What criteria/data was used to discard these?' - type: textarea id: risk attributes: label: 'โŒ Risks' - description: 'What other things happening could conflict or compete (for example for resources) with the proposal? What risk are there and how do we plan to handle them?' + description: 'What other things happening could conflict or compete (for example for resources) with the proposal?' + placeholder: 'What risk are there and how do we plan to handle them?' - type: checkboxes id: no-duplicate-issues attributes: diff --git a/.github/ISSUE_TEMPLATE/ux_component.yaml b/.github/ISSUE_TEMPLATE/ux_component.yaml index 97280b67bf..c528356eb3 100644 --- a/.github/ISSUE_TEMPLATE/ux_component.yaml +++ b/.github/ISSUE_TEMPLATE/ux_component.yaml @@ -6,34 +6,37 @@ body: - type: markdown attributes: value: | - We value your time and efforts to submit this UX Component form. ๐Ÿ™ + We value your time and efforts to submit this RFC form. ๐Ÿ™ - type: textarea id: ux-general validations: required: true attributes: label: '๐Ÿ”– General' - description: | - 'Write a nice note to the community requesting the creation of a new component. Include an image of your component. Bonus points for a GIF!' + description: 'Write a nice note to the community requesting the creation of a new component.' + placeholder: 'Include an image of your component. Bonus points for a GIF!' - type: textarea id: usage validations: required: true attributes: label: '๐Ÿ’ป Usage' - description: "Tell us what's the point of this component/pattern is. How does it help? How should it work? Any rules?" + description: "Tell us what's the point of this component/pattern is." + placeholder: 'How does it help? How should it work? Any rules?' - type: textarea id: specs validations: required: true attributes: label: '๐Ÿ“ Specs' - description: "Include images that detail the redlines for your component. Once we get our Figma workspace set up, we'll be posting the Figma files rather than doing specs by hand." + description: 'Include images that detail the redlines for your component.' + placeholder: "Once we get our Figma workspace set up, we'll be posting the Figma files rather than doing specs by hand." - type: textarea id: future attributes: label: '๐Ÿ”ฎ Future' description: 'List out any upcoming, exciting functionality for this component.' + placeholder: 'The component will have ...' - type: checkboxes id: no-duplicate-issues attributes: From a272d70367b66b46c7481c79198c3fb4efb2fca9 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 5 Jan 2024 16:13:21 +0000 Subject: [PATCH 4/6] chore(deps): update dependency @types/humanize-duration to v3.27.4 Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- yarn.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/yarn.lock b/yarn.lock index 15212e967e..2f6945686e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -18060,9 +18060,9 @@ __metadata: linkType: hard "@types/humanize-duration@npm:^3.18.1, @types/humanize-duration@npm:^3.25.1, @types/humanize-duration@npm:^3.27.1": - version: 3.27.3 - resolution: "@types/humanize-duration@npm:3.27.3" - checksum: 33a13bf6206a7708ed0cac83fa98e13314774ba4fd15ab19e454ef9e413d625e9e508ddcbfc32ee9b0093d938ad4a3aee764543b4edc0ebb05d62c1bbc363598 + version: 3.27.4 + resolution: "@types/humanize-duration@npm:3.27.4" + checksum: aa7fa41af839021c846a1728d2f097b7885f80acbc5050623a9804d23fd8fee19d2654eaae331f000a4e551b88d99cd0b5f6cc97aa99f869b9205f6248066827 languageName: node linkType: hard From 516fd3e91862ab86a265100fada6f247d183f92e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Tue, 9 Jan 2024 08:40:26 +0100 Subject: [PATCH 5/6] updated backend/frontend system readme files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelรถw --- .changeset/quiet-oranges-bake.md | 11 +++++++++++ packages/backend-app-api/README.md | 4 +--- packages/backend-defaults/README.md | 2 -- packages/backend-dev-utils/README.md | 2 -- packages/backend-next/README.md | 2 +- packages/backend-plugin-api/README.md | 4 +--- packages/frontend-app-api/README.md | 4 ++-- packages/frontend-plugin-api/README.md | 4 ++-- packages/frontend-test-utils/README.md | 2 ++ 9 files changed, 20 insertions(+), 15 deletions(-) create mode 100644 .changeset/quiet-oranges-bake.md diff --git a/.changeset/quiet-oranges-bake.md b/.changeset/quiet-oranges-bake.md new file mode 100644 index 0000000000..a7360c9e4a --- /dev/null +++ b/.changeset/quiet-oranges-bake.md @@ -0,0 +1,11 @@ +--- +'@backstage/frontend-plugin-api': patch +'@backstage/frontend-test-utils': patch +'@backstage/backend-plugin-api': patch +'@backstage/backend-dev-utils': patch +'@backstage/backend-defaults': patch +'@backstage/frontend-app-api': patch +'@backstage/backend-app-api': patch +--- + +Updated README to reflect release status diff --git a/packages/backend-app-api/README.md b/packages/backend-app-api/README.md index e5b80abeaf..3fd6170b4f 100644 --- a/packages/backend-app-api/README.md +++ b/packages/backend-app-api/README.md @@ -1,8 +1,6 @@ # @backstage/backend-app-api -**This package is EXPERIMENTAL, we recommend against using it for production deployments** - -This package provides the core API used by Backstage backend apps. +This package provides the framework API used by Backstage backend apps. ## Installation diff --git a/packages/backend-defaults/README.md b/packages/backend-defaults/README.md index 2dcc5766df..01e42d42c4 100644 --- a/packages/backend-defaults/README.md +++ b/packages/backend-defaults/README.md @@ -1,7 +1,5 @@ # @backstage/backend-defaults -**This package is EXPERIMENTAL, we recommend against using it for production deployments** - This package provides the default implementations and setup for a standard Backstage backend app. ## Installation diff --git a/packages/backend-dev-utils/README.md b/packages/backend-dev-utils/README.md index cebe591d50..744a9d2ca0 100644 --- a/packages/backend-dev-utils/README.md +++ b/packages/backend-dev-utils/README.md @@ -1,7 +1,5 @@ # @backstage/backend-dev-utils -**This package is EXPERIMENTAL, but we encourage use of it to add support for the new backend system in your own plugins** - This package helps set up local development environments for Backstage backend packages. ## Installation diff --git a/packages/backend-next/README.md b/packages/backend-next/README.md index 94fc0767c4..4634e5673f 100644 --- a/packages/backend-next/README.md +++ b/packages/backend-next/README.md @@ -1,5 +1,5 @@ # example-backend-next -This is an example backend for the new **EXPERIMENTAL** Backstage backend system. +This is an example backend for [the new Backstage backend system](https://backstage.io/docs/backend-system/). Do not use this in your own projects. diff --git a/packages/backend-plugin-api/README.md b/packages/backend-plugin-api/README.md index a17c8715a7..b827ecc50c 100644 --- a/packages/backend-plugin-api/README.md +++ b/packages/backend-plugin-api/README.md @@ -1,8 +1,6 @@ # @backstage/backend-plugin-api -**This package is EXPERIMENTAL, but we encourage use of it to add support for the new backend system in your own plugins** - -This package provides the core API used by Backstage backend plugins and modules. +This package provides the framework API used by Backstage backend plugins and modules. ## Installation diff --git a/packages/frontend-app-api/README.md b/packages/frontend-app-api/README.md index 8b2fe5dc23..256ae99462 100644 --- a/packages/frontend-app-api/README.md +++ b/packages/frontend-app-api/README.md @@ -1,8 +1,8 @@ # @backstage/frontend-app-api -**This package is EXPERIMENTAL, we recommend against using it for production deployments** +**The [new frontend system](https://backstage.io/docs/frontend-system/) that this package is part of is in alpha, and we do not yet recommend using it for production deployments** -This package provides the core API used by Backstage frontend apps. It implements the design outlined in [RFC: Frontend System Evolution](https://github.com/backstage/backstage/issues/18372). +This package provides the framework API used by Backstage frontend apps. It implements the design outlined in [RFC: Frontend System Evolution](https://github.com/backstage/backstage/issues/18372). ## Documentation diff --git a/packages/frontend-plugin-api/README.md b/packages/frontend-plugin-api/README.md index 1fd3da79d8..aedf740840 100644 --- a/packages/frontend-plugin-api/README.md +++ b/packages/frontend-plugin-api/README.md @@ -1,8 +1,8 @@ # @backstage/frontend-plugin-api -**This package is EXPERIMENTAL, we recommend against using it for production deployments** +**The [new frontend system](https://backstage.io/docs/frontend-system/) that this package is part of is in alpha, and we do not yet recommend using it for production deployments** -This package provides the core API used by Backstage frontend plugins. It implements the design outlined in [RFC: Frontend System Evolution](https://github.com/backstage/backstage/issues/18372). +This package provides the framework API used by Backstage frontend plugins. It implements the design outlined in [RFC: Frontend System Evolution](https://github.com/backstage/backstage/issues/18372). ## Documentation diff --git a/packages/frontend-test-utils/README.md b/packages/frontend-test-utils/README.md index 50f853d9ed..455d112773 100644 --- a/packages/frontend-test-utils/README.md +++ b/packages/frontend-test-utils/README.md @@ -1,5 +1,7 @@ # @backstage/frontend-test-utils +**The [new frontend system](https://backstage.io/docs/frontend-system/) that this package is part of is in alpha, and we do not yet recommend using it for production deployments** + Contains utilities that can be used when testing frontend features such as extensions. ## Installation From a8eca44b3e3a7df2cccfd8bd2ac68de9c054b248 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 9 Jan 2024 08:32:33 +0000 Subject: [PATCH 6/6] build(deps): bump follow-redirects from 1.15.2 to 1.15.4 in /microsite Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.2 to 1.15.4. - [Release notes](https://github.com/follow-redirects/follow-redirects/releases) - [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.2...v1.15.4) --- updated-dependencies: - dependency-name: follow-redirects dependency-type: indirect ... Signed-off-by: dependabot[bot] --- microsite/yarn.lock | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/microsite/yarn.lock b/microsite/yarn.lock index 7fb45745ca..36c4f4bdac 100644 --- a/microsite/yarn.lock +++ b/microsite/yarn.lock @@ -5874,12 +5874,12 @@ __metadata: linkType: hard "follow-redirects@npm:^1.0.0, follow-redirects@npm:^1.14.9": - version: 1.15.2 - resolution: "follow-redirects@npm:1.15.2" + version: 1.15.4 + resolution: "follow-redirects@npm:1.15.4" peerDependenciesMeta: debug: optional: true - checksum: faa66059b66358ba65c234c2f2a37fcec029dc22775f35d9ad6abac56003268baf41e55f9ee645957b32c7d9f62baf1f0b906e68267276f54ec4b4c597c2b190 + checksum: e178d1deff8b23d5d24ec3f7a94cde6e47d74d0dc649c35fc9857041267c12ec5d44650a0c5597ef83056ada9ea6ca0c30e7c4f97dbf07d035086be9e6a5b7b6 languageName: node linkType: hard