|
| 1 | +--- |
| 2 | +nav-title: Maintainer Guidance |
| 3 | +--- |
| 4 | + |
| 5 | +# Implementation Guidance for Maintainers |
| 6 | + |
| 7 | +Are you a project maintainer looking to evaluate your project against the OSPS Baseline? |
| 8 | +This page contains guidance to help you do it quickly. |
| 9 | +Your feedback is always welcome in the [issues](https://github.com/ossf/security-baseline/issues). |
| 10 | + |
| 11 | +The Baseline website includes a Markdown-formatted checklist that you can use in a repository issue to track the controls by level. |
| 12 | +See the [main page](/) for links to the checklist. |
| 13 | + |
| 14 | +## Use Security Insights |
| 15 | + |
| 16 | +The [Security Insights project](https://github.com/ossf/security-insights) maintains a specification for projects to report information about their security in a machine-processable way. |
| 17 | +Many tools for Baseline evaluation will use this to evaluate controls that are not easily machine-auditable via platform APIs. |
| 18 | + |
| 19 | +To get started with Security Insights: |
| 20 | + |
| 21 | +. Adopt the Security Insights specification by creating a security-insights.yml file in your repository. |
| 22 | +. Populate the security-insights.yml file with security data for your project following the example-full.yml template. |
| 23 | + |
| 24 | +## Evaluation tooling |
| 25 | + |
| 26 | +Several tools are available to help you automate the process. |
| 27 | + |
| 28 | +* [LFX Insights](https://insights.linuxfoundation.org/) provides automated measurement and reporting of a variety of project metrics, including Baseline controls. |
| 29 | +If your project is not already included in LFX Insights, you can [add it](https://github.com/linuxfoundation/insights/discussions/categories/project-onboardings?discussions_q=is:open+category:%22Project+onboardings%22+sort:top). |
| 30 | +Your project does not need to be a part of the Linux Foundation. |
| 31 | +* [Privateer Plugin for GitHub Repositories](https://github.com/revanite-io/pvtr-github-repo) performs automated checks of some Baseline controls. |
| 32 | +This is what powers the LFX Insights evaluation. |
| 33 | +It is also available as a [GitHub Action](https://github.com/marketplace/actions/osps-security-assessment). |
| 34 | + |
| 35 | +## Additional information |
| 36 | + |
| 37 | +* OpenSSF case study for how [GUAC used LFX Insights](https://openssf.org/blog/2025/08/14/case-study-how-lfx-insights-and-osps-baseline-validated-guacs-security-in-under-an-hour/) to quickly evaluate against levels 1 and 2. |
0 commit comments