https://github.com/tduniec/backstage-timesaver-plugin

This plugin provides an implementation of charts and statistics related to your time savings that are coming from usage of your templates. Plugins is built from frontend and backend part. This part of plugin `frontend` is responsible of providing views with charts describing data collected from `backend` part of plugin.
https://github.com/tduniec/backstage-timesaver-plugin

Last synced: 8 days ago
JSON representation

This plugin provides an implementation of charts and statistics related to your time savings that are coming from usage of your templates. Plugins is built from frontend and backend part. This part of plugin `frontend` is responsible of providing views with charts describing data collected from `backend` part of plugin.

• Host: GitHub
• URL: https://github.com/tduniec/backstage-timesaver-plugin
• Owner: tduniec
• License: apache-2.0
• Created: 2024-01-30T10:09:04.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-14T12:11:08.000Z (about 1 month ago)
• Last Synced: 2024-10-23T09:07:12.753Z (22 days ago)
• Language: TypeScript
• Size: 7.53 MB
• Stars: 17
• Watchers: 2
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Time Saver

This plugin provides an implementation of charts and statistics related to your time savings that are coming from usage of your templates. Plugins is built from frontend and backend part. This part of plugin `frontend` is responsible of providing views with charts describing data collected from `backend` part of plugin.

## Repos

- [time-saver](./plugins/time-saver)

- [time-saver-backend](./plugins/time-saver-backend)

- [time-saver-common](./plugins/time-saver-common)

- [time-saver-processor](./plugins/catalog-backend-module-time-saver-processor)

## Screens

![Screenshot of the AllStats plugin Charts](./plugins/time-saver/docs/tsAllStats.png)

![Screenshot of the AllStats2 plugin Charts](./plugins/time-saver/docs/tsAllStats2.png)

![Screenshot of the ByTeam plugin Charts](./plugins/time-saver/docs/tsByTeam.png)

![Screenshot of the ByTemplate plugin Charts](./plugins/time-saver/docs/tsByTemplate.png)

## Installation

Please follow the instructions in each plugin README.md

## Generate Statistics

Configure your template definition like described below:

Provide an object under `metadata`. Provide quantities of saved time by each group executing one template in **_hours_** preferably

```diff

 apiVersion: scaffolder.backstage.io/v1beta3

 kind: Template

 metadata:

     name: example-template

     title: create-github-project

     description: Creates Github project

+      substitute:

+        engineering:

+          devops: 1

+          security: 4

+          development_team: 2

 spec:

     owner: group:default/backstage-admins

     type: service

```

Scheduler is running with its default setup every **5 minutes** to generate data from executed templates with these information.

## Migration

This plugins supports backward compatibility with migration. You can specify your Time Saver metadata for each template name. Then the migration will be performed once executing the API request to `/migrate` endpoint of the plugin.

Configure your backward time savings here:

Open the `app-config.yaml` file

```yaml

ts:

  backward:

    config: |

      [

        {

          "entityRef": "template:default/create-github-project",

          "engineering": {

            "devops": 8,

            "development_team": 8,

            "security": 3

          }

        } 

      ]

    # extend this list if needed

```