Skip to content

Commit 7a563cf

Browse files
committed
docs: update readme with usage
1 parent bbcedc9 commit 7a563cf

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"cSpell.words": [
3+
"msrv"
4+
]
5+
}

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
1-
# msrv
2-
Read MSRV from package or workspace manifest
1+
# MSRV
2+
3+
> Read MSRV from package or workspace manifest.
4+
5+
## Usage
6+
7+
```yml
8+
jobs:
9+
read_msrv:
10+
name: Read MSRV
11+
uses: actions-rust-lang/msrv/.github/workflows/msrv.yml@main
12+
13+
build_and_test:
14+
needs:
15+
- read_msrv
16+
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
version:
21+
- { name: msrv, version: "${{ needs.read_msrv.outputs.msrv }}" }
22+
- { name: stable, version: stable }
23+
```
24+
25+
## Drawbacks
26+
27+
- Assumes all packages in workspace have same MSRV.

0 commit comments

Comments
 (0)