Set up your GitHub Actions workflow with a specific version of ORAS
Go to file
Xiaoxuan Wang 8d34698a59
bump: add oras v1.2.3 to setup-oras (#95)
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Co-authored-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
2025-04-29 15:54:02 +08:00
.github bump: add oras v1.2.3 to setup-oras (#95) 2025-04-29 15:54:02 +08:00
dist bump: add oras v1.2.3 to setup-oras (#95) 2025-04-29 15:54:02 +08:00
src bump: add oras v1.2.3 to setup-oras (#95) 2025-04-29 15:54:02 +08:00
.gitignore feat: implement setup-oras (#1) 2023-01-21 01:05:00 +08:00
CODEOWNERS docs: add Xiaoxuan Wang as a maintainer (#87) 2025-03-25 13:03:49 -07:00
CODE_OF_CONDUCT.md feat: implement setup-oras (#1) 2023-01-21 01:05:00 +08:00
LICENSE Initial commit 2023-01-18 11:45:53 +08:00
MAINTAINERS.md docs: add Xiaoxuan Wang as a maintainer (#87) 2025-03-25 13:03:49 -07:00
OWNERS.md chore: add shizhMSFT to CODEOWNERS and OWNERS.md (#3) 2023-02-15 09:48:26 -06:00
README.md chore: update README CLI docs website (#43) 2024-07-17 22:44:02 +08:00
SECURITY.md doc: add SECURITY.md file (#16) 2023-08-31 10:06:24 +08:00
action.yml bump: add oras v1.2.3 to setup-oras (#95) 2025-04-29 15:54:02 +08:00
package-lock.json chore(deps): Bump @types/node from 22.14.1 to 22.15.2 (#94) 2025-04-29 07:32:39 +00:00
package.json chore(deps): Bump @types/node from 22.14.1 to 22.15.2 (#94) 2025-04-29 07:32:39 +00:00
tsconfig.json refactor: revamp setup action with typescript (#18) 2023-09-08 16:01:37 +08:00

README.md

setup-oras

banner

Setup ORAS CLI on GitHub Actions runners.

Quick Start

Setup the oras CLI of the default version:

steps:
  - uses: oras-project/setup-oras@v1
  - run: oras version

Advanced Usage

Install a specific version of the oras CLI by specifying the input version without the prefix v. Stable versions (not pre-release versions) are supported and can be found at oras releases.

For example, install oras version v1.0.0.

steps:
  - uses: oras-project/setup-oras@v1
    with:
      version: 1.0.0
  - run: oras version

You can also download oras CLI from any preferred trusted source, by specifying link of the source via url and the SHA256 checksum via checksum. This can be used to download a pre-release version or download from a proxy other than github.com.

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

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 the project website.

Code of Conduct

This project has adopted the CNCF Code of Conduct. See CODE_OF_CONDUCT.md for further details.