Skip to content

Commit

Permalink
update readme && add ossf scorecard workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
tchapacan committed Mar 28, 2024
1 parent 8b65649 commit 6ff9b76
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 2 deletions.
74 changes: 74 additions & 0 deletions .github/workflows/scorecard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# 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: 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: '24 6 * * 5'
push:
branches: [ "main" ]

# 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@1b1aada464948af03b950897e5eb522f92603cc2 # v3.24.9
with:
sarif_file: results.sarif

13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# livebox-exporter-rs (️WIP)

<p>
<a href="https://github.com/tchapacan/livebox-exporter-rs">
<img src="https://img.shields.io/badge/dynamic/toml?url=https://raw.githubusercontent.com/tchapacan/livebox-exporter-rs/master/Cargo.toml&query=$.package.version&style=for-the-badge&label=Version" alt="version">
</a>
<a href="https://github.com/tchapacan/livebox-exporter-rs/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/tchapacan/livebox-exporter-rs.svg?style=for-the-badge" alt="license">
</a>
<a href="https://github.com/tchapacan/livebox-exporter-rs/actions?query=workflow%3A%22Code%20Checks%22">
<img src="https://img.shields.io/github/actions/workflow/status/tchapacan/livebox-exporter-rs/code-checks.yml?style=for-the-badge" alt="github ci workflow">
</a>
<a href="https://api.securityscorecards.dev/projects/github.com/tchapacan/livebox-exporter-rs">
<img src="https://api.securityscorecards.dev/projects/github.com/tchapacan/livebox-exporter-rs/badge?style=for-the-badge" alt="ossf scorecard">
</a>
</p>

A basic livebox exporter written in [rust](https://doc.rust-lang.org/book/title-page.html) 🦀. Start monitoring your livebox router's using [Prometheus](https://github.com/prometheus/prometheus) / [Grafana](https://github.com/grafana/grafana) 💪.
Expand Down Expand Up @@ -94,11 +103,11 @@ Options:

## Details

![overview schema](./images/livebox-exporter-rs_details.svg)

- Use the [prometheus_exporter_base](https://github.com/MindFlavor/prometheus_exporter_base) crate for formatting Prometheus metrics.
- Based on a rework version of the [livebox](https://crates.io/crates/livebox/) rust client project to output additional metrics.

> Schema soon available..

## Contributing

Contributions are really welcome! If you encounter any issues, have suggestions, or would like to add/fix features, please do:
Expand Down
Loading

0 comments on commit 6ff9b76

Please sign in to comment.