Commit Graph

29 Commits

Author SHA1 Message Date
github-actions[bot] 29f2606ed9 Version Packages 2021-12-02 12:35:24 +00:00
Patrik Oldsberg 1f7c345191 Merge pull request #8093 from RoadieHQ/scorecard-tech-insights
Scorecard for tech insights
2021-12-02 12:04:27 +01:00
jluk-box c6c8b8e53e Minor fixes in tech insights plugins readme
Signed-off-by: Jarek Łukow <jlukow@box.com>
2021-12-01 15:49:03 +01:00
Fredrik Adelöw de1f77b71c Merge pull request #8233 from backstage/freben/less-cross
🧹  Align on usage of `cross-fetch` vs `node-fetch` in frontend vs backend packages
2021-11-26 10:15:50 +01:00
github-actions[bot] ef34f5de7b Version Packages 2021-11-25 12:40:52 +00:00
Fredrik Adelöw b055a6addc Align on usage of cross-fetch vs node-fetch in frontend vs backend packages
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-11-25 13:05:08 +01:00
irma12 f4420c7767 Merge branch 'master' into scorecard-tech-insights
Signed-off-by: irma12 <irma@roadie.io>
2021-11-23 12:15:21 +01:00
Fredrik Adelöw e62bf29c1d Merge pull request #8069 from goenning/fix-techinsights-docs
Fix techinsights docs: replaced DefaultTechInsightsBuilder with buildTechInsightsContext
2021-11-22 14:41:26 +01:00
github-actions[bot] 99bf179ccf Version Packages 2021-11-18 11:52:08 +00:00
Iain Billett 325be576ea Actually use the entity filters
Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-17 17:37:18 +00:00
Iain Billett 8cb41885f5 Pass entityFilter to fact retriever handler context
Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-17 16:49:19 +00:00
Iain Billett ccc8a7ff5d Split fact retrievers
Split fact retriever into severeal more specialised retrievers.
Ditch the dynamic addition of annotation facts in favour of
explicit annotation facts. Having dynamic facts makes the
versioning system somewhat meaningless.

Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-17 15:22:01 +00:00
irma12 dc62dcab12 Introduce scorecards
Signed-off-by: irma12 <irma@roadie.io>
2021-11-17 14:28:54 +01:00
Guilherme Oenning 2a0703d212 fix incorrect class name on backend
Signed-off-by: goenning <me@goenning.net>
2021-11-16 11:42:55 +00:00
Iain Billett 8cf89aab38 Api docs
Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-16 09:22:30 +00:00
Iain Billett d4a3dbb75b Expose catalogFactRetriever & configure in backend
Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-15 18:33:29 +00:00
Iain Billett 5b31874a76 Add hasTags schema
Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-15 18:33:20 +00:00
Iain Billett 2d4593254f Dynamic annotations
Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-15 18:29:32 +00:00
Iain Billett 9d2d1bd00c Add some more test cases
Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-15 18:29:32 +00:00
Iain Billett 23195a4494 Add some more test cases
Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-15 18:29:32 +00:00
Iain Billett f091863f03 Add an entity fact retriever
Signed-off-by: Iain Billett <iain@roadie.io>
2021-11-15 18:29:32 +00:00
Jussi Hallila b863feefbb Address warnings within api-docs
Move extra info on doc to be under remarks block

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-10-29 15:20:58 +02:00
Jussi Hallila 9c19d6ad01 Tweak formatting of snippets on README.md files.
Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-10-29 15:20:58 +02:00
Jussi Hallila 5ebfedd9c2 Add new api-report
Update persistence context to not be wrapped into a useless class. Modify the way test databases are created.

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-10-29 15:20:58 +02:00
Jussi Hallila 29faa2ace2 Update cli version
Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-10-29 15:20:58 +02:00
Jussi Hallila 2b3e959ef4 Modifications after PR review
* Change entity filter to be an actual entity filter instead of a list of kinds or types
* Modify/simplify types a little bit
* Split common type libs to one for node and one isomorphic
* Remove unnecessary items from FactChecker interface to simplify execution loop.

Needs still matching README.md changes.

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-10-29 15:20:58 +02:00
Jussi Hallila df000b9596 Address various code review comments.
Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-10-29 15:20:58 +02:00
Jussi Hallila b2363f3e3b Add explicit type information to checks
Types can be used to:
* Determine which check logic to run
* Determine the correct persistence option to use
* Choose correct ser/deser logic for the check
* Determine correct components to render on the frontend

Modify router API to be post for better usability. The API might end up doing writes if caching etc. is added in later as well.

Modify CheckRegistry & FactChecker to return persisted check when it is registered.

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-10-29 15:20:58 +02:00
Jussi Hallila 75fc6ac85b Implement Tech Insights backend
* Add common types and interfaces for Tech Insights. Exposing components needed to use and modify tech-insights-backend module and to implement individual Fact Retrievers, Fact Checkers and their persistence options.

* Implement a framework to run fact retrievers and store fact data into the database. Add migration scripts to create a new database for `tech_insights`.

* Create a default implementation of a FactChecker enabling users to construct checks and run them and generate scorecards based on checks.

* To be able to use tech insights in your application you need to implement `FactRetriever`s to retrieve and return data for facts and register them to the tech-insights-backend. If you want to use fact checking functionality, you need to create `check`s and register them to an implementation of a `FactChecker`.

For more information see documentation on the README.md files of the respective packages.

Signed-off-by: Jussi Hallila <jussi@hallila.com>
2021-10-29 15:20:58 +02:00