Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New tech insights maturity plugin based on tech-insights #2464

Merged
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
4fecafd
init tech-insights-maturity
hballangan-mdsol Jan 8, 2025
b7e2e42
add eslint
hballangan-mdsol Jan 8, 2025
51f12dc
Merge branch 'main' into feature/tech-insights-maturity
hballangan-mdsol Jan 8, 2025
b38f33c
rename plugin export naming
hballangan-mdsol Jan 8, 2025
c77b522
update readme
hballangan-mdsol Jan 8, 2025
7c06ca5
Merge branch 'feature/tech-insights-maturity' of https://github.com/h…
hballangan-mdsol Jan 8, 2025
808b10e
MaturityApiRef to extend TechInsightsApiRef
hballangan-mdsol Jan 9, 2025
4be4f05
sanitize and refactor
hballangan-mdsol Jan 10, 2025
d6a88c7
export EntityMaturitySummaryContent
hballangan-mdsol Jan 10, 2025
4b1be66
fix remaining issue
hballangan-mdsol Jan 10, 2025
8a65ddb
Merge branch 'main' into feature/tech-insights-maturity
hballangan-mdsol Jan 10, 2025
4d118c2
update package dependencies
hballangan-mdsol Jan 10, 2025
a6d175e
Merge branch 'feature/tech-insights-maturity' of https://github.com/h…
hballangan-mdsol Jan 10, 2025
af95e28
resolve use-react tsc issue
hballangan-mdsol Jan 10, 2025
f65e2f9
run prettier
hballangan-mdsol Jan 10, 2025
4c047d2
generate build report
hballangan-mdsol Jan 10, 2025
b55548e
use workspace package
hballangan-mdsol Jan 10, 2025
4851de9
yarn fix
hballangan-mdsol Jan 10, 2025
83506bc
move tech-insights-maturity to tech-insights workspace
hballangan-mdsol Jan 15, 2025
da85c52
refactor
hballangan-mdsol Jan 17, 2025
779c07e
add missing dependency
hballangan-mdsol Jan 17, 2025
70cf7c9
fix imported dependency
hballangan-mdsol Jan 17, 2025
7d9f67b
refactor getMaturityScore
hballangan-mdsol Jan 17, 2025
b7b9b95
remove custom org implementations
hballangan-mdsol Jan 18, 2025
eb490da
Apply suggestions from code review
hballangan-mdsol Jan 20, 2025
e1bdccb
refactor MaturityLink
hballangan-mdsol Jan 20, 2025
6d40b0a
remove non-common plugin dependencies in maturity-common
hballangan-mdsol Jan 21, 2025
15d9ac9
remove unused components
hballangan-mdsol Jan 23, 2025
ca3e683
remove unused components
hballangan-mdsol Jan 23, 2025
a609310
Update workspaces/tech-insights/plugins/tech-insights-maturity/src/ap…
hballangan-mdsol Jan 23, 2025
ed2ca6d
update packages and report
hballangan-mdsol Jan 23, 2025
4042fb1
update yarn packages
hballangan-mdsol Jan 24, 2025
1853ac5
sync merge conflict
hballangan-mdsol Jan 24, 2025
789c66e
Merge branch 'main' into feature/tech-insights-maturity
hballangan-mdsol Jan 24, 2025
957590a
run yarn dedupe
hballangan-mdsol Jan 24, 2025
1e4514f
generate api report md
hballangan-mdsol Jan 24, 2025
a799199
Merge branch 'main' into feature/tech-insights-maturity
hballangan-mdsol Jan 24, 2025
ec0a186
refactor maturityrank
hballangan-mdsol Jan 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions workspaces/tech-insights/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@
"@backstage-community/plugin-tech-insights": "workspace:^",
"@backstage-community/plugin-tech-insights-backend": "workspace:^",
"@backstage-community/plugin-tech-insights-backend-module-jsonfc": "workspace:^",
"@backstage-community/plugin-tech-insights-maturity": "workspace:^",
"@backstage-community/plugin-tech-insights-maturity-common": "workspace:^",
"fast-json-stable-stringify": "^2.1.0"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
"@backstage-community/plugin-tech-insights",
"@backstage-community/plugin-tech-insights-backend",
"@backstage-community/plugin-tech-insights-common",
"@backstage-community/plugin-tech-insights-maturity",
"@backstage-community/plugin-tech-insights-maturity-common",
"@backstage-community/plugin-tech-insights-node"
]
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
"@backstage-community/plugin-tech-insights",
"@backstage-community/plugin-tech-insights-backend",
"@backstage-community/plugin-tech-insights-common",
"@backstage-community/plugin-tech-insights-maturity",
"@backstage-community/plugin-tech-insights-maturity-common",
"@backstage-community/plugin-tech-insights-node"
]
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# @backstage-community/plugin-tech-insights-maturity-common

Welcome to the common package for the tech-insights-maturity plugin!

_This plugin was created through the Backstage CLI_
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{
"name": "@backstage-community/plugin-tech-insights-maturity-common",
"description": "Common functionalities for the tech-insights-maturity plugin",
"version": "0.1.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
"publishConfig": {
"access": "public"
},
"exports": {
".": "./src/index.ts",
"./package.json": "./package.json"
},
"typesVersions": {
"*": {
"package.json": [
"package.json"
]
}
},
"backstage": {
"role": "common-library",
"pluginId": "tech-insights",
"pluginPackages": [
"@backstage-community/plugin-tech-insights",
"@backstage-community/plugin-tech-insights-backend",
"@backstage-community/plugin-tech-insights-common",
"@backstage-community/plugin-tech-insights-maturity",
"@backstage-community/plugin-tech-insights-maturity-common",
"@backstage-community/plugin-tech-insights-node"
]
},
"keywords": [
"backstage",
"tech-insights",
"tech-insights-maturity"
],
"repository": {
"type": "git",
"url": "https://github.com/backstage/community-plugins",
"directory": "workspaces/tech-insights/plugins/tech-insights-maturity-common"
},
"sideEffects": false,
"scripts": {
"build": "backstage-cli package build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"clean": "backstage-cli package clean",
"prepack": "backstage-cli package prepack",
"postpack": "backstage-cli package postpack"
},
"dependencies": {
"@backstage-community/plugin-tech-insights-common": "workspace:^",
"@backstage/repo-tools": "0.3.5",
"msw": "2.7.0"
},
"devDependencies": {
"@backstage/cli": "^0.29.4"
},
"files": [
"dist"
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
## API Report File for "@backstage-community/plugin-tech-insights-maturity-common"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts
import { BooleanCheckResult } from '@backstage-community/plugin-tech-insights-common';
import { CheckResponse } from '@backstage-community/plugin-tech-insights-common';

// @public (undocumented)
export type BulkMaturityCheckResponse = EntityMaturityCheckResult[];

// @public (undocumented)
export type BulkMaturitySummary = EntityMaturitySummary[];

// @public (undocumented)
export interface EntityMaturityCheckResult extends MaturityRank {
// (undocumented)
checks: MaturityCheckResult[];
// (undocumented)
entity: string;
}

// @public (undocumented)
export interface EntityMaturitySummary {
// (undocumented)
entity: string;
// (undocumented)
summary: MaturitySummary;
}

// @public
export interface MaturityCheckResponse extends CheckResponse {
// (undocumented)
metadata: {
category: string;
rank: Rank;
solution: string;
exp: number;
};
}

// @public
export interface MaturityCheckResult extends BooleanCheckResult {
// (undocumented)
check: MaturityCheckResponse;
}

// @public (undocumented)
export interface MaturityProgress {
// (undocumented)
passedChecks: number;
// (undocumented)
percentage: number;
// (undocumented)
totalChecks: number;
}

// @public (undocumented)
export interface MaturityRank {
// (undocumented)
isMaxRank: boolean;
// (undocumented)
rank: Rank;
}

// @public
export interface MaturityScore {
// (undocumented)
checks: MaturityCheckResult[];
// (undocumented)
rank: MaturityRank;
// (undocumented)
summary: MaturitySummary;
}

// @public (undocumented)
export interface MaturitySummary extends MaturityRank {
// (undocumented)
areaSummaries: MaturitySummaryByArea[];
// (undocumented)
maxRank: Rank;
// (undocumented)
points: number;
// (undocumented)
progress: MaturityProgress;
// (undocumented)
rankProgress: MaturityProgress;
}

// @public (undocumented)
export interface MaturitySummaryByArea extends MaturityRank {
// (undocumented)
area: string;
// (undocumented)
maxRank: Rank;
// (undocumented)
progress: MaturityProgress;
// (undocumented)
rankProgress: MaturityProgress;
}

// @public
export enum Rank {
// (undocumented)
Bronze = 1,
// (undocumented)
Gold = 3,
// (undocumented)
Silver = 2,
// (undocumented)
Stone = 0,
}

// (No @packageDocumentation comment for this package)
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*
* Copyright 2025 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export * from './types';
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
/*
* Copyright 2025 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
BooleanCheckResult,
CheckResponse,
} from '@backstage-community/plugin-tech-insights-common';

/**
* Maturity Rank enum
*
* @public
*/
export enum Rank {
Stone,
Bronze,
Silver,
Gold,
}

/**
* MaturityCheckResponse with maturity metadata
*
* @public
*/
export interface MaturityCheckResponse extends CheckResponse {
metadata: {
category: string;
rank: Rank;
solution: string;
exp: number;
};
}

/**
* Maturity CheckResult
*
* @public
*/
export interface MaturityCheckResult extends BooleanCheckResult {
check: MaturityCheckResponse;
}

/**
* Maturity Score
*
* @public
*/
export interface MaturityScore {
checks: MaturityCheckResult[];
summary: MaturitySummary;
rank: MaturityRank;
}

/**
* @public
*/
export interface MaturityRank {
rank: Rank;
isMaxRank: boolean;
}

/**
* @public
*/
export interface MaturityProgress {
passedChecks: number;
totalChecks: number;
percentage: number;
}

/**
* @public
*/
export interface MaturitySummaryByArea extends MaturityRank {
area: string;
progress: MaturityProgress;
rankProgress: MaturityProgress;
maxRank: Rank;
}

/**
* @public
*/
export interface MaturitySummary extends MaturityRank {
points: number;
progress: MaturityProgress;
rankProgress: MaturityProgress; // progress to gain the next rank
maxRank: Rank;
areaSummaries: MaturitySummaryByArea[];
}

/**
* @public
*/
export interface EntityMaturityCheckResult extends MaturityRank {
entity: string;
checks: MaturityCheckResult[];
}

/**
* @public
*/
export interface EntityMaturitySummary {
entity: string;
summary: MaturitySummary;
}

/**
* @public
*/
export type BulkMaturityCheckResponse = EntityMaturityCheckResult[];

/**
* @public
*/
export type BulkMaturitySummary = EntityMaturitySummary[];
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);
Loading
Loading