From 9e5e7c53e10d8aa35ca053aeae94856886385359 Mon Sep 17 00:00:00 2001 From: Tom Longridge Date: Thu, 5 Dec 2024 11:58:49 +0000 Subject: [PATCH] docs: add security policy and rebrand readme also added openssf scorecard job --- .github/workflows/scorecard.yml | 73 +++++++++++++++++++++++++++++++++ README.md | 30 +++++++------- SECURITY.md | 12 ++++++ 3 files changed, 100 insertions(+), 15 deletions(-) create mode 100644 .github/workflows/scorecard.yml create mode 100644 SECURITY.md diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml new file mode 100644 index 000000000..49f90310d --- /dev/null +++ b/.github/workflows/scorecard.yml @@ -0,0 +1,73 @@ +# This workflow uses actions that are not certified by GitHub. They are provided +# by a third-party and are governed by separate terms of service, privacy +# policy, and support documentation. + +name: OpenSSF Scorecard +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: '0 0 * * 0' + push: + branches: [ "next" ] + +# Declare default permissions as read only. +permissions: read-all + +jobs: + analysis: + name: Scorecard analysis + runs-on: ubuntu-latest + 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 + # Uncomment the permissions below if installing in a private repository. + # contents: read + # actions: read + + steps: + - name: "Checkout code" + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + with: + persist-credentials: false + + - name: "Run analysis" + uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.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 + + # 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@97a0fba1372883ab732affbe8f94b823f91727db # v3.pre.node20 + 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 diff --git a/README.md b/README.md index a3d2c018d..f896d4980 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,18 @@ -# Bugsnag error monitoring & exception reporter for iOS, macOS, tvOS and watchOS -[![iOS Documentation](https://img.shields.io/badge/ios_documentation-latest-blue.svg)](https://docs.bugsnag.com/platforms/ios/) -[![macOS Documentation](https://img.shields.io/badge/macos_documentation-latest-blue.svg)](https://docs.bugsnag.com/platforms/macos/) -[![tvOS Documentation](https://img.shields.io/badge/tvos_documentation-latest-blue.svg)](https://docs.bugsnag.com/platforms/tvos/) -[![watchOS Documentation](https://img.shields.io/badge/watchos_documentation-latest-blue.svg)](https://docs.bugsnag.com/platforms/watchos/) +
+ + + + SmartBear BugSnag logo + + +

Error monitoring & exception reporter for iOS, macOS, tvOS and watchOS

+
+ +[![Documentation](https://img.shields.io/badge/documentation-latest-blue.svg)](https://docs.bugsnag.com/platforms/ios/) [![Build status](https://badge.buildkite.com/bc15523ca2dc56d1a9fd61a1c0e93b99adba62f229a1c3379b.svg?branch=master)](https://buildkite.com/bugsnag/bugsnag-cocoa) +[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/bugsnag/bugsnag-cocoa/badge)](https://scorecard.dev/viewer/?uri=github.com/bugsnag/bugsnag-cocoa) -The Bugsnag crash reporter for Cocoa library automatically detects crashes in your iOS 9.0+, macOS 10.11+, tvOS 9.2+ and watchOS 6.3+ applications, collecting diagnostic information and immediately notifying your development team, helping you to understand and resolve issues as fast as possible. Learn more about [iOS crash reporting with Bugsnag](https://www.bugsnag.com/platforms/ios-crash-reporting/). +Detect crashes in your iOS, macOS, tvOS and watchOS applications: collecting diagnostic information and immediately notifying your development team, helping you to understand and resolve issues as fast as possible. ## Features @@ -14,7 +21,6 @@ The Bugsnag crash reporter for Cocoa library automatically detects crashes in yo * Log breadcrumbs which are attached to crash reports and add insight to users' actions * Attach user information and custom diagnostic data to determine how many people are affected by a crash - ## Getting started ### iOS @@ -44,16 +50,10 @@ The Bugsnag crash reporter for Cocoa library automatically detects crashes in yo * [Search open and closed issues](https://github.com/bugsnag/bugsnag-cocoa/issues?utf8=✓&q=is%3Aissue) for similar problems * [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-cocoa/issues/new) - ## Contributing -All contributors are welcome! For information on how to build, test, -and release `bugsnag-cocoa`, see our -[contributing guide](https://github.com/bugsnag/bugsnag-cocoa/blob/master/CONTRIBUTING.md). - +All contributors are welcome! For information on how to build, test and release `bugsnag-cocoa`, see our [contributing guide](https://github.com/bugsnag/bugsnag-cocoa/blob/master/CONTRIBUTING.md). ## License -The Bugsnag Cocoa library is free software released under the MIT License. -See [LICENSE.txt](https://github.com/bugsnag/bugsnag-cocoa/blob/master/LICENSE.txt) -for details. +The BugSnag Cocoa SDK is free software released under the MIT License. See the [LICENSE](https://github.com/bugsnag/bugsnag-cocoa/blob/master/LICENSE) for details. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..445bb0b0d --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,12 @@ +# Security Policy + +## Supported Versions + +| Version | Supported | +| ------- | --------------------- | +| 5.x | Critical patches only | +| 6.x | Yes | + +## Reporting a Vulnerability + +If you find a vulnerability in this SDK, please report it to our [Support team](mailto:support@bugsnag.com) for review. \ No newline at end of file