Skip to content

Commit be8a9a8

Browse files
committed
docs: add status badges and wire coverage reporting
1 parent 74527df commit be8a9a8

File tree

2 files changed

+58
-1
lines changed

2 files changed

+58
-1
lines changed

.github/workflows/ci.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,33 @@ jobs:
2929

3030
- name: Tests
3131
run: cargo test --all-features
32+
33+
coverage:
34+
needs: build
35+
runs-on: ubuntu-latest
36+
steps:
37+
- name: Checkout
38+
uses: actions/checkout@v4
39+
40+
- name: Install stable toolchain with coverage tools
41+
uses: dtolnay/rust-toolchain@stable
42+
with:
43+
components: clippy,rustfmt,llvm-tools-preview
44+
45+
- name: Cache cargo
46+
uses: Swatinem/rust-cache@v2
47+
48+
- name: Install cargo-llvm-cov
49+
uses: taiki-e/install-action@v2
50+
with:
51+
tool: cargo-llvm-cov
52+
53+
- name: Generate coverage report
54+
run: cargo llvm-cov --workspace --lcov --output-path lcov.info
55+
56+
- name: Upload coverage to Codecov
57+
uses: codecov/codecov-action@v5
58+
with:
59+
files: lcov.info
60+
flags: rust
61+
fail_ci_if_error: true

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Plausible CLI
22

3+
<div align="center">
4+
5+
[![Crates.io][crate-badge]][crate-url]
6+
[![Repo][repo-badge]][repo-url]
7+
[![Docs][docs-badge]][docs-url]
8+
[![License][license-badge]][license-url]
9+
[![CI][ci-badge]][ci-url]
10+
[![Dependencies][deps-badge]][deps-url]
11+
[![Coverage][coverage-badge]][coverage-url]
12+
13+
</div>
14+
315
A Rust-native command-line interface that surfaces the Plausible Analytics APIs
416
with a workflow tailored for humans and automation agents.
517

@@ -155,4 +167,19 @@ cargo test
155167

156168
Issues and PRs are welcome. Please run the commands in the **Testing** section
157169
before submitting changes. For new features, add coverage via unit/async tests
158-
and update the documentation when behavior changes.*** End Patch
170+
and update the documentation when behavior changes.
171+
172+
[crate-badge]: https://img.shields.io/crates/v/plausible-cli.svg?label=crates.io&logo=rust
173+
[crate-url]: https://crates.io/crates/plausible-cli
174+
[repo-badge]: https://img.shields.io/badge/github-vicentereig%2Fplausible--cli-181717?logo=github
175+
[repo-url]: https://github.com/vicentereig/plausible-cli
176+
[docs-badge]: https://img.shields.io/badge/docs-llms--full.txt-blue?logo=readthedocs
177+
[docs-url]: https://github.com/vicentereig/plausible-cli/blob/main/docs/llms-full.txt
178+
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
179+
[license-url]: https://github.com/vicentereig/plausible-cli/blob/main/LICENSE
180+
[ci-badge]: https://img.shields.io/github/actions/workflow/status/vicentereig/plausible-cli/ci.yml?branch=main&label=CI&logo=github
181+
[ci-url]: https://github.com/vicentereig/plausible-cli/actions/workflows/ci.yml
182+
[deps-badge]: https://deps.rs/repo/github/vicentereig/plausible-cli/status.svg
183+
[deps-url]: https://deps.rs/repo/github/vicentereig/plausible-cli
184+
[coverage-badge]: https://codecov.io/gh/vicentereig/plausible-cli/branch/main/graph/badge.svg
185+
[coverage-url]: https://codecov.io/gh/vicentereig/plausible-cli

0 commit comments

Comments
 (0)