Skip to content

Commit

Permalink
Merge pull request #2118 from bugsnag/tom/openssf-scorecard
Browse files Browse the repository at this point in the history
Docs and OpenSSF scorecard updates
  • Loading branch information
tomlongridge authored Jan 6, 2025
2 parents a37bf9a + d4ad164 commit 0e18c1e
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 16 deletions.
73 changes: 73 additions & 0 deletions .github/workflows/scorecard.yml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
bugsnag-android/ @lemnik @YYChen01988
bugsnag-android-core/ @lemnik @YYChen01988
bugsnag-plugin-android-anr/ @lemnik @YYChen01988
bugsnag-plugin-android-exitinfo/ @lemnik @YYChen01988
bugsnag-plugin-android-ndk/ @lemnik @YYChen01988
bugsnag-plugin-android-okhttp/ @lemnik @YYChen01988
bugsnag-plugin-react-native/ @lemnik @YYChen01988
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# Bugsnag error monitoring & exception reporter for Android
[![Documentation](https://img.shields.io/badge/documentation-latest-blue.svg)](https://docs.bugsnag.com/platforms/android/)
<div align="center">
<a href="https://www.bugsnag.com/platforms/android">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://assets.smartbear.com/m/3dab7e6cf880aa2b/original/BugSnag-Repository-Header-Dark.svg">
<img alt="SmartBear BugSnag logo" src="https://assets.smartbear.com/m/3945e02cdc983893/original/BugSnag-Repository-Header-Light.svg">
</picture>
</a>
<h1>Error monitoring &amp; exception reporter for Android</h1>
</div>

Get comprehensive [Android crash reports](https://www.bugsnag.com/platforms/android/) to quickly debug errors.
[![Documentation](https://img.shields.io/badge/documentation-latest-blue.svg)](https://docs.bugsnag.com/platforms/android/)
[![Build status](https://badge.buildkite.com/ff6aa35c92e06a739cb095b58762dffab8011c7f05a1ce86e1.svg)](https://buildkite.com/bugsnag/bugsnag-android)
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/bugsnag/bugsnag-android/badge)](https://scorecard.dev/viewer/?uri=github.com/bugsnag/bugsnag-android)

Bugsnag's [Android crash reporting](https://www.bugsnag.com/platforms/android/)
library automatically detects crashes in your Android apps, collecting
diagnostic information and immediately notifying your development team, helping
you to understand and resolve issues as fast as possible.
Detect crashes in your Android applications: collecting diagnostic information and immediately notifying your development team, helping you to understand and resolve issues as fast as possible.

## Features

Expand All @@ -30,17 +36,10 @@ you to understand and resolve issues as fast as possible.
* [Search open and closed issues](https://github.com/bugsnag/bugsnag-android/issues?utf8=✓&q=is%3Aissue) for similar problems
* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-android/issues/new)


## Contributing

All contributors are welcome! For information on how to build, test
and release `bugsnag-android`, see our
[contributing guide](https://github.com/bugsnag/bugsnag-android/blob/master/CONTRIBUTING.md).

Bugsnag employees should start by reading [the docs](docs/README.md).
All contributors are welcome! For information on how to build, test and release `bugsnag-android`, see our [contributing guide](https://github.com/bugsnag/bugsnag-android/blob/main/CONTRIBUTING.md).

## License

The Bugsnag Android notifier is free software released under the MIT License.
See the [LICENSE](https://github.com/bugsnag/bugsnag-android/blob/master/LICENSE)
for details.
The BugSnag Android SDK is free software released under the MIT License. See the [LICENSE](https://github.com/bugsnag/bugsnag-android/blob/main/LICENSE) for details.
12 changes: 12 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 0e18c1e

Please sign in to comment.