Skip to content

Commit

Permalink
Update image with examples
Browse files Browse the repository at this point in the history
  • Loading branch information
rajbos committed Sep 20, 2023
1 parent 0da98b2 commit be61c42
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 17 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@

Extension for Azure DevOps that shows the number of open security alerts for the configured repository. Please install it and let me know what you think! Create an issue for feedback or feature requests.
Extension for Azure DevOps that shows the number of open security alerts for the configured repository. Please install it and let me know what you think! Create an issue for feedback or feature requests.
Install the extension from the Azure DevOps marketplace: https://marketplace.visualstudio.com/items?itemName=RobBos.GHAzDoWidget

## Example:
![Screenshot of the widget showing the repository name and the alert count for dependencies, secrets, and code scanning](/img/example_2x1.png)

# Things that I can think of to add:
## Widgets:
* Show all three alert counts in one widget in 2 by 1 layout
* Split it into three separate widgets with just the single value you scan for (1x1 or 2x1)
* Show a trend line of all alerts in the last 3 weeks (2x2,3x2,4x2)

![Screenshot of the widget showing the repository name and the alert count for dependencies, secrets, and code scanning](/img/overview_600.png)

- Think of more use cases:
- show the total number of alerts for the project
- show only a single number instead of all three (or add a checkbox for each alert type so users can mix and match)
- Add chart with the number of alerts over time (1 line for active and maybe a line for closed?)
# Things that I can think of to add:

- show the total number of alerts for the whole project
- group trend line by months
- stacked trend line (open/closed) per alert type

## How to build the package

Expand Down
Binary file added img/overview_600.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 5 additions & 9 deletions overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,12 @@ Extension for Azure DevOps that shows the number of open security alerts for the

Install from the marketplace: https://marketplace.visualstudio.com/items?itemName=RobBos.GHAzDoWidget

## Examples:
## Widgets:
* Show all three alert counts in one widget in 2 by 1 layout
* Split it into three separate widgets with just the single value you scan for (1x1 or 2x1)
* Show a trend line of all alerts in the last 3 weeks (2x2,3x2,4x2)

### Show all three alert counts in one widget in 2 by 1 layout:
![Screenshot of the widget in 2 by 1 showing the repository name and the alert count for dependencies, secrets, and code scanning](/img/example_2x1.png)

### Split it into three separate widgets (1 by 1) with just the single value you scan for:
![Screenshot of the widget in 1 by 1 showing the repository name and the alert count for dependencies, secrets, and code scanning](/img/example_1x1.png)

### Show a trend line (2 by 2) of all alerts in the last 3 weeks:
![Screenshot of the chart widget in 2 by 2 showing the repository name and the alert count for dependencies, secrets, and code scanning](/img/example_chart_2x2.png)
![Screenshot of the all the widgets with alert count for dependencies, secrets, and code scanning](/img/overview_600.png)

## GitHub repo
Please report issues, feature request, and feedback here: https://github.com/rajbos/GHAzDo-widget.
Expand Down

0 comments on commit be61c42

Please sign in to comment.