Skip to content

Commit 8e86a16

Browse files
committed
fix(docs): add criteria for compatibility
1 parent dcc28c3 commit 8e86a16

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@ The primary goals are, in order of priority:
1010

1111
## Supported releases
1212

13+
This action only supports installing from releases where the release:
14+
15+
- is tagged with the full `{major}.{minor}.{patch}` semantic version
16+
- contains raw binary assets (archives not supported)
17+
- assets are labeled ending with the binary's [target triple]
18+
19+
You can create compatible releases with [semantic-release], using a workflow like this [semantic-release Rust action].
20+
21+
[semantic-release]: https://github.com/semantic-release/semantic-release
22+
[semantic-release rust action]: https://github.com/ericcrosson/rust-action
23+
[target triple]: https://doc.rust-lang.org/nightly/rustc/platform-support.html
24+
1325
## Use
1426

1527
Use this action in a step:

0 commit comments

Comments
 (0)