Skip to content

Commit

Permalink
chore: update README to add an example
Browse files Browse the repository at this point in the history
Signed-off-by: Xiaoxuan Wang <[email protected]>
  • Loading branch information
wangxiaoxuan273 committed Jun 6, 2024
1 parent 339758d commit 6b12586
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ steps:
## Advanced Usage
Install a specific version of the `oras` CLI by specifying the input `version` without the prefix `v`.
Supported versions can be found at [`oras` releases](https://github.com/oras-project/oras/releases).
Stable versions (not `beta` or `rc` versions) that can be found at [`oras` releases](https://github.com/oras-project/oras/releases) are supported.

For example, install `oras` version `v1.0.0`.

Expand All @@ -31,6 +31,24 @@ steps:
- run: oras version
```

You can also download `oras` CLI from a customized link, by specifying the inputs `url`
and `checksum`. This can be used to download a `beta` or `rc` version, or download
from a proxy. Both inputs must be provided.

When both `url` and `checksum` are provided, the `version` value is ignored and the
download will be from `url` and checked against `checksum`.

For example, install `oras` version `v1.2.0-beta.1`.

```yaml
steps:
- uses: oras-project/setup-oras@v1
with:
url: https://github.com/oras-project/oras/releases/download/v1.2.0-beta.1/oras_1.2.0-beta.1_linux_amd64.tar.gz
checksum: 37d86f848f7c7c471035cf8218f06372fd72a9fbdca1e10f509738e222b3b2be
- run: oras version
```

## Docs

Documentation for the ORAS CLI is located on
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ inputs:
required: false
default: 1.2.0
url:
description: URL of the customized ORAS CLI to install
description: URL of the customized ORAS CLI to install. Required if 'checksum' is present.
required: false
checksum:
description: SHA256 of the customized ORAS CLI. Required if 'url' is present.
Expand Down

0 comments on commit 6b12586

Please sign in to comment.