Skip to content

Commit cc38bc8

Browse files
committed
feat: add providers page
1 parent 197e1a5 commit cc38bc8

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
sidebar_position: 6
3+
title: Providers
4+
slug: /visionBoard/providers
5+
---
6+
7+
Providers are external data sources integrated into VisionBoard to collect and process information. Examples include the [GitHub API](#github-api) and [OSSF Scorecard](#ossf-scorecard). These providers operate through workflows that ensure data quality using JSON Schema before storing it in the database. For an in-depth understanding, refer to the [Architecture documentation](/docs/visionBoard/architecture).
8+
9+
## GitHub API
10+
11+
The [GitHub API](https://docs.github.com/en/rest?apiVersion=2022-11-28) is used solely for data queries. Ensure you configure your token correctly. For large organizations with hundreds of repositories, using dedicated tokens is recommended to avoid hitting quota limits. [Learn more about GitHub tokens](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting).
12+
13+
Here are examples of workflows that use this provider:
14+
15+
- `visionboard workflow run --name update-github-orgs`: Fetches and updates detailed information about GitHub organizations.
16+
- `visionboard workflow run --name upsert-github-repositories`: Finds and fetches details for all public repositories.
17+
18+
## OSSF Scorecard
19+
20+
The [OSSF Scorecard](https://scorecard.dev/) is included in VisionBoard for analyzing repository health and security. The analysis runs locally using [child processes](https://nodejs.org/api/child_process.html) and containers in parallel. Results are stored in the database for efficient access and fast queries via [reports](/docs/visionBoard/report-management).
21+
22+
For detailed insights, refer to the Scorecard table available on project pages. This table includes repository names, commit hashes, analysis duration (in seconds), dates, and security scores for each repository.
23+
24+
![OSSF Scorecard Analysis table displaying repositories, commit hashes, analysis duration (in seconds), date, and scores for six OpenPathfinder repositories.](/img/visionBoard_project_report_detials_ossf_scorecard.png)
1.71 MB
Loading

0 commit comments

Comments
 (0)