From e8a4ac062c4e7516fc28bc464cc23bd4d10e5d6b Mon Sep 17 00:00:00 2001 From: Simon Date: Fri, 30 Jun 2023 10:29:08 +0200 Subject: [PATCH] Publish plugin to @weaveworksoss/backstage-plugin-flux (#6) * Publish plugin to @weaveworksoss/backstage-plugin-flux - @weaveworks doesn't work right now as npm cannot handle per-package scope and it conflicts with the github npm registry that hosts the @weaveworks/weave-gitops dependency - Move the `private: true` up to the top to keep npm/yarn happy when publishing, this seems to be a yarn/npm workplace constraint * Adds release instructions * adds test/build/lint ci too * Adds example .npmrc for publishing manually * Fix more linting errors now that its switched on in CI * Move license to just cover the plugin - Include it in bundle too --- .github/workflows/ci.yaml | 28 ++ .github/workflows/publish.yaml | 21 + .npmrc | 2 - README.md | 24 +- package.json | 1 + packages/app/package.json | 2 +- packages/app/src/App.tsx | 2 +- .../app/src/components/catalog/EntityPage.tsx | 2 +- plugins/backstage-plugin-flux/.npmrc.example | 4 + plugins/backstage-plugin-flux/LICENSE | 373 ++++++++++++++++++ plugins/backstage-plugin-flux/README.md | 18 +- plugins/backstage-plugin-flux/package.json | 7 +- plugins/backstage-plugin-flux/publish.sh | 6 + .../src/components/Flex.tsx | 12 +- .../FluxEntityOCIRepositoriesCard.test.tsx} | 0 .../FluxEntityOCIRepositoriesCard.tsx} | 2 +- .../FluxOCIRepositoriesTable.tsx} | 0 .../index.ts | 0 .../src/components/Icon.tsx | 20 +- .../src/components/KubeStatusIndicator.tsx | 2 +- .../src/components/Text.tsx | 2 +- .../src/components/WeaveGitOpsContext.tsx | 2 +- .../src/components/utils.test.ts | 3 +- plugins/backstage-plugin-flux/src/objects.ts | 9 +- plugins/backstage-plugin-flux/src/theme.ts | 89 ++--- yarn.lock | 2 +- 26 files changed, 544 insertions(+), 89 deletions(-) create mode 100644 .github/workflows/ci.yaml create mode 100644 .github/workflows/publish.yaml delete mode 100644 .npmrc create mode 100644 plugins/backstage-plugin-flux/.npmrc.example create mode 100644 plugins/backstage-plugin-flux/LICENSE create mode 100755 plugins/backstage-plugin-flux/publish.sh rename plugins/backstage-plugin-flux/src/components/{FluxEntityOciRepositoriesCard/FluxEntityOciRepositoriesCard.test.tsx => FluxEntityOCIRepositoriesCard/FluxEntityOCIRepositoriesCard.test.tsx} (100%) rename plugins/backstage-plugin-flux/src/components/{FluxEntityOciRepositoriesCard/FluxEntityOciRepositoriesCard.tsx => FluxEntityOCIRepositoriesCard/FluxEntityOCIRepositoriesCard.tsx} (96%) rename plugins/backstage-plugin-flux/src/components/{FluxEntityOciRepositoriesCard/FluxOciRepositoriesTable.tsx => FluxEntityOCIRepositoriesCard/FluxOCIRepositoriesTable.tsx} (100%) rename plugins/backstage-plugin-flux/src/components/{FluxEntityOciRepositoriesCard => FluxEntityOCIRepositoriesCard}/index.ts (100%) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..84c134f --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,28 @@ +name: CI + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + env: + # for @weaveworks/weave-gitops which is on github npm packages + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - uses: actions/setup-node@v3 + with: + node-version: '16.x' + - run: yarn install + - run: yarn lint + - run: yarn tsc + - run: yarn test + - run: yarn build:all diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 0000000..4581988 --- /dev/null +++ b/.github/workflows/publish.yaml @@ -0,0 +1,21 @@ +name: Publish Package to npmjs +on: + release: + types: [published] +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: '16.x' + registry-url: 'https://registry.npmjs.org' + scope: '@weaveworksoss' + - run: | + cd plugins/backstage-plugin-flux + yarn install --frozen-lockfile + ./publish + env: + NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.npmrc b/.npmrc deleted file mode 100644 index 7b4a51b..0000000 --- a/.npmrc +++ /dev/null @@ -1,2 +0,0 @@ -@weaveworks:registry=https://npm.pkg.github.com -//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN} diff --git a/README.md b/README.md index 9db8c59..413f4d8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # [Backstage](https://backstage.io) -This is your newly scaffolded Backstage App, Good Luck! +## Local dev For local dev we'll need to set up a Github OAuth app and a local kubernetes cluster. -## Configure Github OAuth +### Configure Github OAuth Follow the [Backstage instructions to create a Github OAuth app](https://backstage.io/docs/auth/github/provider#create-an-oauth-app-on-github), relevant bit here: @@ -14,7 +14,7 @@ Follow the [Backstage instructions to create a Github OAuth app](https://backsta > - **Homepage URL**: http://localhost:3000 > - **Authorization callback URL**: http://localhost:7007/api/auth/github/handler/frame -Save the clientId and clientSecret that Github generates into a `.env` file or your `~/.bashrc` / `~/.zshrc`: +Save the **clientId** and **clientSecret** that Github generates into a `.env` file or your `~/.bashrc` / `~/.zshrc`: ```bash export AUTH_GITHUB_CLIENT_ID=abc123 @@ -23,7 +23,7 @@ export AUTH_GITHUB_CLIENT_SECRET=abc123 They're referenced in the `app-config.kubernetes.yaml` file. -## Start a local kubernetes cluster +### Start a local kubernetes cluster To start the app, run: @@ -47,3 +47,19 @@ cp ./app-config.kubernetes.yaml ./app-config.local.yaml # start the app, configuring backstage to use serviceaccount in ./demo ./startup.sh ``` + +## Releasing + +Publishing a **GitHub release** will trigger a GitHub Action to build and push the npm module to the [backstage-plugin-flux npm package](https://www.npmjs.com/package/@weaveworksoss/backstage-plugin-flux). + +### Create the release + +Create a [new Github release](https://github.com/weaveworks/weaveworks-backstage/releases/new) + +1. Click "Choose a tag" and type in the tag that the release should create on publish (e.g. `v0.5.0`) +2. Click **Generate release notes** +3. Click **Publish release** + +After a few minutes the release should be available on npm. + +Follow the [backstage-plugin-flux installation instructions](./plugins/backstage-plugin-flux/README.md) to upgrade the plugin in your Backstage app. diff --git a/package.json b/package.json index 97b7e4a..d3144e4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,7 @@ { "name": "root", "version": "1.0.0", + "license": "Apache-2.0", "private": true, "engines": { "node": "16 || 18" diff --git a/packages/app/package.json b/packages/app/package.json index 05ebbb8..b5b8d88 100644 --- a/packages/app/package.json +++ b/packages/app/package.json @@ -44,7 +44,7 @@ "@backstage/plugin-techdocs-react": "^1.1.6", "@backstage/plugin-user-settings": "^0.7.3", "@backstage/theme": "^0.3.0", - "@weaveworks/backstage-plugin-flux": "^0.1.0", + "@weaveworksoss/backstage-plugin-flux": "^0.1.0", "@material-ui/core": "^4.12.2", "@material-ui/icons": "^4.9.1", "history": "^5.0.0", diff --git a/packages/app/src/App.tsx b/packages/app/src/App.tsx index 0a9cb70..c0e61d3 100644 --- a/packages/app/src/App.tsx +++ b/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 { FluxEntityHelmReleasesCard } from '@weaveworks/backstage-plugin-flux'; +import { FluxEntityHelmReleasesCard } from '@weaveworksoss/backstage-plugin-flux'; const app = createApp({ components: { diff --git a/packages/app/src/components/catalog/EntityPage.tsx b/packages/app/src/components/catalog/EntityPage.tsx index 300b0de..aec6ed3 100644 --- a/packages/app/src/components/catalog/EntityPage.tsx +++ b/packages/app/src/components/catalog/EntityPage.tsx @@ -56,7 +56,7 @@ import { import { TechDocsAddons } from '@backstage/plugin-techdocs-react'; import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib'; import { EntityKubernetesContent } from '@backstage/plugin-kubernetes'; -import { FluxEntityHelmReleasesCard } from '@weaveworks/backstage-plugin-flux'; +import { FluxEntityHelmReleasesCard } from '@weaveworksoss/backstage-plugin-flux'; const techdocsContent = ( diff --git a/plugins/backstage-plugin-flux/.npmrc.example b/plugins/backstage-plugin-flux/.npmrc.example new file mode 100644 index 0000000..447ac42 --- /dev/null +++ b/plugins/backstage-plugin-flux/.npmrc.example @@ -0,0 +1,4 @@ +//registry.npmjs.org/:_authToken=${NPM_TOKEN} +registry=https://registry.npmjs.org/ +always-auth=true + diff --git a/plugins/backstage-plugin-flux/LICENSE b/plugins/backstage-plugin-flux/LICENSE new file mode 100644 index 0000000..a612ad9 --- /dev/null +++ b/plugins/backstage-plugin-flux/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/plugins/backstage-plugin-flux/README.md b/plugins/backstage-plugin-flux/README.md index 46289de..4daa2df 100644 --- a/plugins/backstage-plugin-flux/README.md +++ b/plugins/backstage-plugin-flux/README.md @@ -26,9 +26,9 @@ roleRef: kind: ClusterRole name: helmrelease-viewer-role subjects: -- kind: ServiceAccount - name: backstage # replace with the name of the SA that your Backstage runs as - namespace: flux-system + - kind: ServiceAccount + name: backstage # replace with the name of the SA that your Backstage runs as + namespace: flux-system ``` ## Installation @@ -37,25 +37,26 @@ Install the plugin dependency in your Backstage app package: ```bash # From your Backstage root directory -yarn add --cwd packages/app @weaveworks/backstage-plugin-flux +yarn add --cwd packages/app @weaveworksoss/backstage-plugin-flux ``` ## Configuration -1. Add the card to your app EntityPage.tsx +1. Add the card to your app EntityPage.tsx + ```tsx // In packages/app/src/components/catalog/EntityPage.tsx -import { FluxEntityHelmReleasesCard } from '@weaveworks/backstage-plugin-flux'; +import { FluxEntityHelmReleasesCard } from '@weaveworksoss/backstage-plugin-flux'; // You can add the tab to any number of pages, the service page is shown as an // example here const overviewContent = ( - // ... + // ... - // ... + // ... ); ``` @@ -80,6 +81,7 @@ spec: ``` 3. Label your Flux HelmRelease with the correct label: + ```yaml apiVersion: helm.toolkit.fluxcd.io/v2beta1 kind: HelmRelease diff --git a/plugins/backstage-plugin-flux/package.json b/plugins/backstage-plugin-flux/package.json index 987ca4a..f411be5 100644 --- a/plugins/backstage-plugin-flux/package.json +++ b/plugins/backstage-plugin-flux/package.json @@ -1,10 +1,9 @@ { - "name": "@weaveworks/backstage-plugin-flux", + "name": "@weaveworksoss/backstage-plugin-flux", "version": "0.1.0", "main": "src/index.ts", "types": "src/index.ts", - "license": "Apache-2.0", - "private": true, + "license": "MPL-2.0", "publishConfig": { "access": "public", "main": "dist/index.esm.js", @@ -33,6 +32,7 @@ "@material-ui/core": "^4.12.2", "@material-ui/icons": "^4.9.1", "@material-ui/lab": "4.0.0-alpha.61", + "lodash": "^4.17.21", "luxon": "^3.3.0", "react-query": "^3.39.3", "react-use": "^17.2.4", @@ -57,6 +57,7 @@ "msw": "^1.0.0" }, "files": [ + "LICENSE", "dist", "config.d.ts" ], diff --git a/plugins/backstage-plugin-flux/publish.sh b/plugins/backstage-plugin-flux/publish.sh new file mode 100755 index 0000000..19a2065 --- /dev/null +++ b/plugins/backstage-plugin-flux/publish.sh @@ -0,0 +1,6 @@ +#!/usr/bin/env bash + +yarn clean +yarn tsc +yarn build +yarn publish diff --git a/plugins/backstage-plugin-flux/src/components/Flex.tsx b/plugins/backstage-plugin-flux/src/components/Flex.tsx index 53e001c..c1c78a1 100644 --- a/plugins/backstage-plugin-flux/src/components/Flex.tsx +++ b/plugins/backstage-plugin-flux/src/components/Flex.tsx @@ -21,11 +21,15 @@ type Props = { 'data-testid'?: string; }; -const Styled = (component: any) => styled(component)` +const withStyles = (component: any) => styled(component)` display: flex; flex-direction: ${({ column }) => (column ? 'column' : 'row')}; - align-items: ${({ align, alignItems }) => - alignItems ? alignItems : align ? 'center' : 'start'}; + align-items: ${({ align, alignItems }) => { + if (alignItems) { + return alignItems; + } + return align ? 'center' : 'start'; + }}; ${({ gap }) => gap && `gap: ${gap}px`}; ${({ tall }) => tall && `height: 100%`}; ${({ wide }) => wide && 'width: 100%'}; @@ -59,4 +63,4 @@ class Flex extends React.PureComponent { } } -export default Styled(Flex); +export default withStyles(Flex); diff --git a/plugins/backstage-plugin-flux/src/components/FluxEntityOciRepositoriesCard/FluxEntityOciRepositoriesCard.test.tsx b/plugins/backstage-plugin-flux/src/components/FluxEntityOCIRepositoriesCard/FluxEntityOCIRepositoriesCard.test.tsx similarity index 100% rename from plugins/backstage-plugin-flux/src/components/FluxEntityOciRepositoriesCard/FluxEntityOciRepositoriesCard.test.tsx rename to plugins/backstage-plugin-flux/src/components/FluxEntityOCIRepositoriesCard/FluxEntityOCIRepositoriesCard.test.tsx diff --git a/plugins/backstage-plugin-flux/src/components/FluxEntityOciRepositoriesCard/FluxEntityOciRepositoriesCard.tsx b/plugins/backstage-plugin-flux/src/components/FluxEntityOCIRepositoriesCard/FluxEntityOCIRepositoriesCard.tsx similarity index 96% rename from plugins/backstage-plugin-flux/src/components/FluxEntityOciRepositoriesCard/FluxEntityOciRepositoriesCard.tsx rename to plugins/backstage-plugin-flux/src/components/FluxEntityOCIRepositoriesCard/FluxEntityOCIRepositoriesCard.tsx index 9e5c1ee..3e1b87b 100644 --- a/plugins/backstage-plugin-flux/src/components/FluxEntityOciRepositoriesCard/FluxEntityOciRepositoriesCard.tsx +++ b/plugins/backstage-plugin-flux/src/components/FluxEntityOCIRepositoriesCard/FluxEntityOCIRepositoriesCard.tsx @@ -6,7 +6,7 @@ import { useOCIRepositories } from '../../hooks'; import { FluxOCIRepositoriesTable, defaultColumns, -} from './FluxOciRepositoriesTable'; +} from './FluxOCIRepositoriesTable'; const OCIRepositoryPanel = () => { const { entity } = useEntity(); diff --git a/plugins/backstage-plugin-flux/src/components/FluxEntityOciRepositoriesCard/FluxOciRepositoriesTable.tsx b/plugins/backstage-plugin-flux/src/components/FluxEntityOCIRepositoriesCard/FluxOCIRepositoriesTable.tsx similarity index 100% rename from plugins/backstage-plugin-flux/src/components/FluxEntityOciRepositoriesCard/FluxOciRepositoriesTable.tsx rename to plugins/backstage-plugin-flux/src/components/FluxEntityOCIRepositoriesCard/FluxOCIRepositoriesTable.tsx diff --git a/plugins/backstage-plugin-flux/src/components/FluxEntityOciRepositoriesCard/index.ts b/plugins/backstage-plugin-flux/src/components/FluxEntityOCIRepositoriesCard/index.ts similarity index 100% rename from plugins/backstage-plugin-flux/src/components/FluxEntityOciRepositoriesCard/index.ts rename to plugins/backstage-plugin-flux/src/components/FluxEntityOCIRepositoriesCard/index.ts diff --git a/plugins/backstage-plugin-flux/src/components/Icon.tsx b/plugins/backstage-plugin-flux/src/components/Icon.tsx index d0c0fa8..fa4b3e7 100644 --- a/plugins/backstage-plugin-flux/src/components/Icon.tsx +++ b/plugins/backstage-plugin-flux/src/components/Icon.tsx @@ -1,6 +1,6 @@ -import CheckCircleIcon from '@material-ui/icons/CheckCircle'; -import RemoveCircleIcon from '@material-ui/icons/RemoveCircle'; -import ErrorIcon from '@material-ui/icons/Error'; +import MuiCheckCircleIcon from '@material-ui/icons/CheckCircle'; +import MuiRemoveCircleIcon from '@material-ui/icons/RemoveCircle'; +import MuiErrorIcon from '@material-ui/icons/Error'; import * as React from 'react'; import styled from 'styled-components'; import suspended from '../images/suspended.svg'; @@ -33,26 +33,28 @@ type Props = { function getIcon(i: IconType) { switch (i) { case IconType.CheckCircleIcon: - return CheckCircleIcon; + return MuiCheckCircleIcon; case IconType.RemoveCircleIcon: - return RemoveCircleIcon; + return MuiRemoveCircleIcon; case IconType.FailedIcon: - return ErrorIcon; + return MuiErrorIcon; case IconType.SuspendedIcon: - return () => ; + return () => suspended; case IconType.ReconcileIcon: - return () => ; + return () => reconcile; case IconType.PendingActionIcon: - return () => ; + return () => pending; default: break; } + + return undefined; } function Icon({ className, type, text, color, fontSize }: Props) { diff --git a/plugins/backstage-plugin-flux/src/components/KubeStatusIndicator.tsx b/plugins/backstage-plugin-flux/src/components/KubeStatusIndicator.tsx index 54401c1..c06451a 100644 --- a/plugins/backstage-plugin-flux/src/components/KubeStatusIndicator.tsx +++ b/plugins/backstage-plugin-flux/src/components/KubeStatusIndicator.tsx @@ -156,7 +156,7 @@ const getBackstageIcon = (color: string) => { return ; default: - return; + return undefined; } }; diff --git a/plugins/backstage-plugin-flux/src/components/Text.tsx b/plugins/backstage-plugin-flux/src/components/Text.tsx index 7969543..33425bd 100644 --- a/plugins/backstage-plugin-flux/src/components/Text.tsx +++ b/plugins/backstage-plugin-flux/src/components/Text.tsx @@ -35,7 +35,7 @@ const Text = styled.span` font-weight: ${props => { if (props.bold) return '800'; else if (props.semiBold) return '600'; - else return '400'; + return '400'; }}; text-transform: ${textTransform}; diff --git a/plugins/backstage-plugin-flux/src/components/WeaveGitOpsContext.tsx b/plugins/backstage-plugin-flux/src/components/WeaveGitOpsContext.tsx index 64e6706..67cb346 100644 --- a/plugins/backstage-plugin-flux/src/components/WeaveGitOpsContext.tsx +++ b/plugins/backstage-plugin-flux/src/components/WeaveGitOpsContext.tsx @@ -15,7 +15,7 @@ export const WeaveGitOpsContext = ({ children }: { children: ReactNode }) => { const queryClient = new QueryClient(queryOptions); return ( - + {children} ); diff --git a/plugins/backstage-plugin-flux/src/components/utils.test.ts b/plugins/backstage-plugin-flux/src/components/utils.test.ts index 8c66cab..a515d0f 100644 --- a/plugins/backstage-plugin-flux/src/components/utils.test.ts +++ b/plugins/backstage-plugin-flux/src/components/utils.test.ts @@ -1,5 +1,4 @@ -import { OCIRepository } from '../hooks'; -import { HelmRelease } from '../objects'; +import { HelmRelease, OCIRepository } from '../objects'; import { automationLastUpdated, findVerificationCondition } from './utils'; describe('automationLastUpdated', () => { diff --git a/plugins/backstage-plugin-flux/src/objects.ts b/plugins/backstage-plugin-flux/src/objects.ts index 31174eb..cfe9b96 100644 --- a/plugins/backstage-plugin-flux/src/objects.ts +++ b/plugins/backstage-plugin-flux/src/objects.ts @@ -125,9 +125,8 @@ export class FluxObject { return Object.keys(annotations).flatMap(key => { if (!key.startsWith(prefix)) { return []; - } else { - return [[key.slice(prefix.length), annotations[key] as string]]; } + return [[key.slice(prefix.length), annotations[key] as string]]; }); } @@ -194,7 +193,7 @@ export class FluxObject { export class HelmRepository extends FluxObject { get repositoryType(): string { - return this.obj.spec?.type == 'oci' ? 'OCI' : 'Default'; + return this.obj.spec?.type === 'oci' ? 'OCI' : 'Default'; } get url(): string { @@ -205,7 +204,7 @@ export class HelmRepository extends FluxObject { export class HelmChart extends FluxObject { get sourceRef(): ObjectRef | undefined { if (!this.obj.spec?.sourceRef) { - return; + return undefined; } const sourceRef = { ...this.obj.spec.sourceRef, @@ -359,7 +358,7 @@ export class HelmRelease extends FluxObject { let chart = this.obj.spec?.chart; chart = { ...chart }; chart.metadata = { - name: this.namespace + '-' + this.name, + name: `${this.namespace}-${this.name}`, namespace: chart.spec?.sourceRef?.namespace || this.namespace, }; return new HelmChart({ diff --git a/plugins/backstage-plugin-flux/src/theme.ts b/plugins/backstage-plugin-flux/src/theme.ts index 1201e00..a798a8c 100644 --- a/plugins/backstage-plugin-flux/src/theme.ts +++ b/plugins/backstage-plugin-flux/src/theme.ts @@ -53,15 +53,15 @@ export const baseTheme = { }; export const theme = (mode: ThemeTypes = ThemeTypes.Light): DefaultTheme => { - //dark - if (mode === ThemeTypes.Dark) + // dark + if (mode === ThemeTypes.Dark) { return { ...baseTheme, colors: { black: '#fff', white: '#1a1a1a', primary: '#009CCC', - //only used in nav text when collapsed + selected/hover + // only used in nav text when collapsed + selected/hover primaryLight05: 'rgba(0,179,236,0.05)', primaryLight10: '#98E0F7', primary10: '#00b3ec', @@ -95,47 +95,48 @@ export const theme = (mode: ThemeTypes = ThemeTypes.Light): DefaultTheme => { }, mode: ThemeTypes.Dark, }; - //light - else - return { - ...baseTheme, - colors: { - black: '#1a1a1a', - white: '#fff', - primary: '#00b3ec', - primaryLight05: '#E5F7FD', - primaryLight10: '#98E0F7', - primary10: '#009CCC', - primary20: '#006B8E', - successLight: '#C9EBD7', - successMedium: '#78CC9C', - successOriginal: '#27AE60', - successDark: '#156034', - alertLight: '#EECEC7', - alertMedium: '#D58572', - alertOriginal: '#BC3B1D', - alertDark: '#9F3119', - neutralGray: '#F6F7F9', - neutral00: '#ffffff', - neutral10: '#f5f5f5', - neutral20: '#d8d8d8', - neutral30: '#737373', - neutral40: '#1a1a1a', - whiteToPrimary: '#fff', - grayToPrimary: '#737373', - backGray: '#eef0f4', - blueWithOpacity: 'rgba(0, 179, 236, 0.1)', - feedbackLight: '#FCE6D2', - feedbackMedium: '#F7BF8E', - feedbackOriginal: '#F2994A', - feedbackDark: '#8A460A', - defaultLight: '#FCE6D2', - defaultMedium: '#F7BF8E', - defaultOriginal: '#F2994A', - defaultDark: '#8A460A', - }, - mode: ThemeTypes.Light, - }; + } + + // light + return { + ...baseTheme, + colors: { + black: '#1a1a1a', + white: '#fff', + primary: '#00b3ec', + primaryLight05: '#E5F7FD', + primaryLight10: '#98E0F7', + primary10: '#009CCC', + primary20: '#006B8E', + successLight: '#C9EBD7', + successMedium: '#78CC9C', + successOriginal: '#27AE60', + successDark: '#156034', + alertLight: '#EECEC7', + alertMedium: '#D58572', + alertOriginal: '#BC3B1D', + alertDark: '#9F3119', + neutralGray: '#F6F7F9', + neutral00: '#ffffff', + neutral10: '#f5f5f5', + neutral20: '#d8d8d8', + neutral30: '#737373', + neutral40: '#1a1a1a', + whiteToPrimary: '#fff', + grayToPrimary: '#737373', + backGray: '#eef0f4', + blueWithOpacity: 'rgba(0, 179, 236, 0.1)', + feedbackLight: '#FCE6D2', + feedbackMedium: '#F7BF8E', + feedbackOriginal: '#F2994A', + feedbackDark: '#8A460A', + defaultLight: '#FCE6D2', + defaultMedium: '#F7BF8E', + defaultOriginal: '#F2994A', + defaultDark: '#8A460A', + }, + mode: ThemeTypes.Light, + }; }; export default theme; diff --git a/yarn.lock b/yarn.lock index 03d6007..4815893 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8275,7 +8275,7 @@ anymatch@^3.0.3, anymatch@~3.1.2: "@backstage/theme" "^0.3.0" "@material-ui/core" "^4.12.2" "@material-ui/icons" "^4.9.1" - "@weaveworks/backstage-plugin-flux" "^0.1.0" + "@weaveworksoss/backstage-plugin-flux" "^0.1.0" history "^5.0.0" react "^17.0.2" react-dom "^17.0.2"