From ae54dfd94370928321b6b566a28d377a3dfcdc0a Mon Sep 17 00:00:00 2001 From: Debabrata Date: Sat, 12 Jul 2025 15:51:49 +0530 Subject: [PATCH] Added the release instruction --- .../packages/app/package.json | 2 +- .../packages/app/src/App.tsx | 2 +- .../plugins/parseable-logstream/README.md | 26 +++++++- .../parseable-logstream/docs/integration.md | 6 +- .../plugins/parseable-logstream/package.json | 16 ++++- .../plugins/parseable-logstream/src/index.ts | 8 +-- .../plugins/parseable-logstream/src/plugin.ts | 4 +- parseable-backstage-plugin/yarn.lock | 60 +++++++++---------- 8 files changed, 77 insertions(+), 47 deletions(-) diff --git a/parseable-backstage-plugin/packages/app/package.json b/parseable-backstage-plugin/packages/app/package.json index e133b22..b9b1aa4 100644 --- a/parseable-backstage-plugin/packages/app/package.json +++ b/parseable-backstage-plugin/packages/app/package.json @@ -39,9 +39,9 @@ "@backstage/plugin-techdocs-react": "^1.2.17", "@backstage/plugin-user-settings": "^0.8.22", "@backstage/theme": "^0.6.6", - "@internal/plugin-parseable-logstream": "workspace:^", "@material-ui/core": "^4.12.2", "@material-ui/icons": "^4.9.1", + "@parseable/backstage-plugin-logstream": "workspace:^", "react": "^18.0.2", "react-dom": "^18.0.2", "react-router": "^6.3.0", diff --git a/parseable-backstage-plugin/packages/app/src/App.tsx b/parseable-backstage-plugin/packages/app/src/App.tsx index 791a594..bb1aa93 100644 --- a/parseable-backstage-plugin/packages/app/src/App.tsx +++ b/parseable-backstage-plugin/packages/app/src/App.tsx @@ -35,7 +35,7 @@ import { AppRouter, FlatRoutes } from '@backstage/core-app-api'; import { CatalogGraphPage } from '@backstage/plugin-catalog-graph'; import { RequirePermission } from '@backstage/plugin-permission-react'; import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha'; -import { ParseableLogstreamPage } from '@internal/plugin-parseable-logstream'; +import { ParseableLogstreamPage } from '@parseable/backstage-plugin-logstream'; const app = createApp({ apis, diff --git a/parseable-backstage-plugin/plugins/parseable-logstream/README.md b/parseable-backstage-plugin/plugins/parseable-logstream/README.md index a5d435c..df7cb3f 100644 --- a/parseable-backstage-plugin/plugins/parseable-logstream/README.md +++ b/parseable-backstage-plugin/plugins/parseable-logstream/README.md @@ -19,7 +19,7 @@ This plugin allows engineers to pull their own Parseable log-streams directly on ```bash # From your Backstage root directory -yarn add --cwd packages/app @internal/plugin-parseable-logstream +yarn add --cwd packages/app @parseable/backstage-plugin-logstream ``` 2. Configure the plugin in your `app-config.yaml`: @@ -36,7 +36,7 @@ You need to set the `PARSEABLE_B64_CRED` environment variable with the Base64 en ```tsx // packages/app/src/App.tsx -import { parseableLogstreamPlugin } from '@internal/plugin-parseable-logstream'; +import { parseableLogstreamPlugin } from '@parseable/backstage-plugin-logstream'; const app = createApp({ // ... @@ -54,7 +54,7 @@ const app = createApp({ import { EntityParseableLogstreamContent, isParseableLogstreamAvailable, -} from '@internal/plugin-parseable-logstream'; +} from '@parseable/backstage-plugin-logstream'; // Add to your entity page layout const serviceEntityPage = ( @@ -126,3 +126,23 @@ To build the plugin: # From the plugin directory yarn build ``` + +## Publishing + +This plugin is published to the npm registry under the `@parseable` organization. To publish a new version: + +```bash +# From the plugin directory +yarn build +npm publish +``` + +Note: You need to be a member of the @parseable organization on npm and logged in via `npm login` to publish. + +## Contributing + +Contributions are welcome! Please feel free to submit a Pull Request. + +## License + +Apache-2.0 diff --git a/parseable-backstage-plugin/plugins/parseable-logstream/docs/integration.md b/parseable-backstage-plugin/plugins/parseable-logstream/docs/integration.md index 1ee3c02..3b3e6d0 100644 --- a/parseable-backstage-plugin/plugins/parseable-logstream/docs/integration.md +++ b/parseable-backstage-plugin/plugins/parseable-logstream/docs/integration.md @@ -13,7 +13,7 @@ This guide provides detailed instructions on how to integrate the Parseable logs From your Backstage root directory, run: ```bash -yarn add --cwd packages/app @internal/plugin-parseable-logstream +yarn add --cwd packages/app @parseable/backstage-plugin-logstream ``` ## Step 2: Configure Authentication @@ -37,7 +37,7 @@ Add the plugin to your Backstage app: ```tsx // packages/app/src/App.tsx -import { parseableLogstreamPlugin } from '@internal/plugin-parseable-logstream'; +import { parseableLogstreamPlugin } from '@parseable/backstage-plugin-logstream'; const app = createApp({ // ... @@ -57,7 +57,7 @@ Add the plugin to your entity page to display log streams: import { EntityParseableLogstreamContent, isParseableLogstreamAvailable, -} from '@internal/plugin-parseable-logstream'; +} from '@parseable/backstage-plugin-logstream'; // Add to your entity page layout const serviceEntityPage = ( diff --git a/parseable-backstage-plugin/plugins/parseable-logstream/package.json b/parseable-backstage-plugin/plugins/parseable-logstream/package.json index 3704cd1..d1664a3 100644 --- a/parseable-backstage-plugin/plugins/parseable-logstream/package.json +++ b/parseable-backstage-plugin/plugins/parseable-logstream/package.json @@ -1,10 +1,20 @@ { - "name": "@internal/plugin-parseable-logstream", + "name": "@parseable/backstage-plugin-logstream", "version": "0.1.0", + "description": "Backstage plugin for integrating with Parseable log streams", + "keywords": ["backstage", "plugin", "parseable", "logs", "monitoring"], + "author": "Parseable", + "homepage": "https://parseable.com", + "repository": { + "type": "git", + "url": "https://github.com/parseablehq/backstage-plugin" + }, + "bugs": { + "url": "https://github.com/parseablehq/backstage-plugin/issues" + }, "main": "src/index.ts", "types": "src/index.ts", "license": "Apache-2.0", - "private": true, "publishConfig": { "access": "public", "main": "dist/index.esm.js", @@ -36,7 +46,7 @@ "zod": "^3.21.4" }, "peerDependencies": { - "react": "^16.13.1 || ^17.0.0", + "react": "^16.13.1 || ^17.0.0 || ^18.0.0", "react-router-dom": "6.0.0-beta.0 || ^6.3.0" }, "devDependencies": { diff --git a/parseable-backstage-plugin/plugins/parseable-logstream/src/index.ts b/parseable-backstage-plugin/plugins/parseable-logstream/src/index.ts index 15c1728..092d199 100644 --- a/parseable-backstage-plugin/plugins/parseable-logstream/src/index.ts +++ b/parseable-backstage-plugin/plugins/parseable-logstream/src/index.ts @@ -2,7 +2,7 @@ export { parseableLogstreamPlugin, ParseableLogstreamPage, EntityParseableLogstreamContent, -} from './plugin.ts'; -export { LogStreamCard } from './components/LogStreamCard.tsx'; -export { isParseableLogstreamAvailable } from './conditions.ts'; -export * from './routes.ts'; +} from './plugin'; +export { LogStreamCard } from './components/LogStreamCard'; +export { isParseableLogstreamAvailable } from './conditions'; +export * from './routes'; diff --git a/parseable-backstage-plugin/plugins/parseable-logstream/src/plugin.ts b/parseable-backstage-plugin/plugins/parseable-logstream/src/plugin.ts index 3fc1f22..47b695c 100644 --- a/parseable-backstage-plugin/plugins/parseable-logstream/src/plugin.ts +++ b/parseable-backstage-plugin/plugins/parseable-logstream/src/plugin.ts @@ -22,7 +22,7 @@ export const ParseableLogstreamPage = parseableLogstreamPlugin.provide( createRoutableExtension({ name: 'ParseableLogstreamPage', component: () => - import('./components/ParseableLogstreamPage.tsx').then(m => m.ParseableLogstreamPage), + import('./components/ParseableLogstreamPage').then(m => m.ParseableLogstreamPage), mountPoint: rootRouteRef, }), ); @@ -32,7 +32,7 @@ export const EntityParseableLogstreamContent = parseableLogstreamPlugin.provide( name: 'EntityParseableLogstreamContent', component: { lazy: () => - import('./components/EntityParseableLogstreamContent.tsx').then( + import('./components/EntityParseableLogstreamContent').then( m => m.EntityParseableLogstreamContent, ), }, diff --git a/parseable-backstage-plugin/yarn.lock b/parseable-backstage-plugin/yarn.lock index 45c7f30..5718ad6 100644 --- a/parseable-backstage-plugin/yarn.lock +++ b/parseable-backstage-plugin/yarn.lock @@ -7246,35 +7246,6 @@ __metadata: languageName: node linkType: hard -"@internal/plugin-parseable-logstream@workspace:^, @internal/plugin-parseable-logstream@workspace:plugins/parseable-logstream": - version: 0.0.0-use.local - resolution: "@internal/plugin-parseable-logstream@workspace:plugins/parseable-logstream" - dependencies: - "@backstage/catalog-model": "npm:^1.4.0" - "@backstage/cli": "npm:^0.22.8" - "@backstage/core-components": "npm:^0.13.0" - "@backstage/core-plugin-api": "npm:^1.5.0" - "@backstage/dev-utils": "npm:^1.0.16" - "@backstage/plugin-catalog-react": "npm:^1.7.0" - "@backstage/test-utils": "npm:^1.4.0" - "@backstage/theme": "npm:^0.4.0" - "@material-ui/core": "npm:^4.12.4" - "@material-ui/icons": "npm:^4.9.1" - "@material-ui/lab": "npm:4.0.0-alpha.61" - "@testing-library/jest-dom": "npm:^5.10.1" - "@testing-library/react": "npm:^12.1.3" - "@testing-library/user-event": "npm:^14.0.0" - "@types/node": "npm:*" - monaco-editor: "npm:^0.40.0" - msw: "npm:^1.0.0" - react-use: "npm:^17.2.4" - zod: "npm:^3.21.4" - peerDependencies: - react: ^16.13.1 || ^17.0.0 - react-router-dom: 6.0.0-beta.0 || ^6.3.0 - languageName: unknown - linkType: soft - "@internationalized/date@npm:^3.8.1": version: 3.8.1 resolution: "@internationalized/date@npm:3.8.1" @@ -9402,6 +9373,35 @@ __metadata: languageName: node linkType: hard +"@parseable/backstage-plugin-logstream@workspace:^, @parseable/backstage-plugin-logstream@workspace:plugins/parseable-logstream": + version: 0.0.0-use.local + resolution: "@parseable/backstage-plugin-logstream@workspace:plugins/parseable-logstream" + dependencies: + "@backstage/catalog-model": "npm:^1.4.0" + "@backstage/cli": "npm:^0.22.8" + "@backstage/core-components": "npm:^0.13.0" + "@backstage/core-plugin-api": "npm:^1.5.0" + "@backstage/dev-utils": "npm:^1.0.16" + "@backstage/plugin-catalog-react": "npm:^1.7.0" + "@backstage/test-utils": "npm:^1.4.0" + "@backstage/theme": "npm:^0.4.0" + "@material-ui/core": "npm:^4.12.4" + "@material-ui/icons": "npm:^4.9.1" + "@material-ui/lab": "npm:4.0.0-alpha.61" + "@testing-library/jest-dom": "npm:^5.10.1" + "@testing-library/react": "npm:^12.1.3" + "@testing-library/user-event": "npm:^14.0.0" + "@types/node": "npm:*" + monaco-editor: "npm:^0.40.0" + msw: "npm:^1.0.0" + react-use: "npm:^17.2.4" + zod: "npm:^3.21.4" + peerDependencies: + react: ^16.13.1 || ^17.0.0 || ^18.0.0 + react-router-dom: 6.0.0-beta.0 || ^6.3.0 + languageName: unknown + linkType: soft + "@pkgjs/parseargs@npm:^0.11.0": version: 0.11.0 resolution: "@pkgjs/parseargs@npm:0.11.0" @@ -14762,9 +14762,9 @@ __metadata: "@backstage/plugin-user-settings": "npm:^0.8.22" "@backstage/test-utils": "npm:^1.7.8" "@backstage/theme": "npm:^0.6.6" - "@internal/plugin-parseable-logstream": "workspace:^" "@material-ui/core": "npm:^4.12.2" "@material-ui/icons": "npm:^4.9.1" + "@parseable/backstage-plugin-logstream": "workspace:^" "@playwright/test": "npm:^1.32.3" "@testing-library/dom": "npm:^9.0.0" "@testing-library/jest-dom": "npm:^6.0.0"