doc: add openssf badges and scanning
Signed-off-by: Jan Larwig <jan@larwig.com>
This commit is contained in:
		
							parent
							
								
									3033e50c6b
								
							
						
					
					
						commit
						b24d85dfbf
					
				|  | @ -0,0 +1,71 @@ | ||||||
|  | name: Scorecard supply-chain security | ||||||
|  | on: | ||||||
|  |   # For Branch-Protection check. Only the default branch is supported. See | ||||||
|  |   # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection | ||||||
|  |   branch_protection_rule: | ||||||
|  |   # To guarantee Maintained check is occasionally updated. See | ||||||
|  |   # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained | ||||||
|  |   schedule: | ||||||
|  |     - cron: "26 12 * * 1" | ||||||
|  |   push: | ||||||
|  |     branches: ["master"] | ||||||
|  | 
 | ||||||
|  | # Declare default permissions as read only. | ||||||
|  | permissions: read-all | ||||||
|  | 
 | ||||||
|  | jobs: | ||||||
|  |   analysis: | ||||||
|  |     name: Scorecard analysis | ||||||
|  |     runs-on: ubuntu-latest | ||||||
|  |     # `publish_results: true` only works when run from the default branch. conditional can be removed if disabled. | ||||||
|  |     if: github.event.repository.default_branch == github.ref_name || github.event_name == 'pull_request' | ||||||
|  |     permissions: | ||||||
|  |       # Needed to upload the results to code-scanning dashboard. | ||||||
|  |       security-events: write | ||||||
|  |       # Needed to publish results and get a badge (see publish_results below). | ||||||
|  |       id-token: write | ||||||
|  | 
 | ||||||
|  |     steps: | ||||||
|  |       - name: "Checkout code" | ||||||
|  |         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||||||
|  |         with: | ||||||
|  |           persist-credentials: false | ||||||
|  | 
 | ||||||
|  |       - name: "Run analysis" | ||||||
|  |         uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1 | ||||||
|  |         with: | ||||||
|  |           results_file: results.sarif | ||||||
|  |           results_format: sarif | ||||||
|  |           # (Optional) "write" PAT token. Uncomment the `repo_token` line below if: | ||||||
|  |           # - you want to enable the Branch-Protection check on a *public* repository, or | ||||||
|  |           # - you are installing Scorecard on a *private* repository | ||||||
|  |           # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional. | ||||||
|  |           # repo_token: ${{ secrets.SCORECARD_TOKEN }} | ||||||
|  | 
 | ||||||
|  |           # Public repositories: | ||||||
|  |           #   - Publish results to OpenSSF REST API for easy access by consumers | ||||||
|  |           #   - Allows the repository to include the Scorecard badge. | ||||||
|  |           #   - See https://github.com/ossf/scorecard-action#publishing-results. | ||||||
|  |           # For private repositories: | ||||||
|  |           #   - `publish_results` will always be set to `false`, regardless | ||||||
|  |           #     of the value entered here. | ||||||
|  |           publish_results: true | ||||||
|  | 
 | ||||||
|  |           # (Optional) Uncomment file_mode if you have a .gitattributes with files marked export-ignore | ||||||
|  |           # file_mode: git | ||||||
|  | 
 | ||||||
|  |       # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF | ||||||
|  |       # format to the repository Actions tab. | ||||||
|  |       - name: "Upload artifact" | ||||||
|  |         uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1 | ||||||
|  |         with: | ||||||
|  |           name: SARIF file | ||||||
|  |           path: results.sarif | ||||||
|  |           retention-days: 5 | ||||||
|  | 
 | ||||||
|  |       # Upload the results to GitHub's code scanning dashboard (optional). | ||||||
|  |       # Commenting out will disable upload of results to your repo's Code Scanning dashboard | ||||||
|  |       - name: "Upload to code-scanning" | ||||||
|  |         uses: github/codeql-action/upload-sarif@v3 | ||||||
|  |         with: | ||||||
|  |           sarif_file: results.sarif | ||||||
							
								
								
									
										11
									
								
								README.md
								
								
								
								
							
							
						
						
									
										11
									
								
								README.md
								
								
								
								
							|  | @ -1,9 +1,12 @@ | ||||||
| [](https://github.com/oauth2-proxy/oauth2-proxy/actions/workflows/ci.yml) | [](https://github.com/oauth2-proxy/oauth2-proxy/actions/workflows/ci.yml) | ||||||
| [](https://goreportcard.com/report/github.com/oauth2-proxy/oauth2-proxy) | [](https://goreportcard.com/report/github.com/oauth2-proxy/oauth2-proxy/v7) | ||||||
| [](https://godoc.org/github.com/oauth2-proxy/oauth2-proxy) | [](https://godoc.org/github.com/oauth2-proxy/oauth2-proxy/v7) | ||||||
| [](./LICENSE) | [](./LICENSE) | ||||||
| [](https://codeclimate.com/github/oauth2-proxy/oauth2-proxy/maintainability) | [](https://qlty.sh/gh/oauth2-proxy/projects/oauth2-proxy) | ||||||
| [](https://codeclimate.com/github/oauth2-proxy/oauth2-proxy/test_coverage) | [](https://qlty.sh/gh/oauth2-proxy/projects/oauth2-proxy) | ||||||
|  | [](https://scorecard.dev/viewer/?uri=github.com/oauth2-proxy/oauth2-proxy) | ||||||
|  | [](https://www.bestpractices.dev/projects/11223) | ||||||
|  | 
 | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
| 
 | 
 | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue