Wwwsylvia/oras-go

ORAS Go library

ORAS Go library

Project status

Versioning

The ORAS Go library follows Semantic Versioning, where breaking changes are reserved for MAJOR releases, and MINOR and PATCH releases must be 100% backwards compatible.

v2: stable

The version 2 is actively developed in the main branch with all new features.

Note

The main branch follows Go's Security Policy and supports the two latest versions of Go (currently 1.20 and 1.21).

Examples for common use cases can be found below:

• Copy examples
• Registry interaction examples
• Repository interaction examples
• Authentication examples

If you are seeking latest changes, you should use the main branch (or a specific commit hash) over a tagged version when including the ORAS Go library in your project's go.mod. The Go Reference for the main branch is available here.

To migrate from v1 to v2, see MIGRATION_GUIDE.md.

v1: stable

As there are various stable projects depending on the ORAS Go library v1, the v1 branch is maintained for API stability, dependency updates, and security patches. All v1.* releases are based upon this branch.

Since v1 is in a maintenance state, you are highly encouraged to use releases with major version 2 for new features.

Docs

• oras.land/client_libraries/go: Documentation for the ORAS Go library
• Reviewing guide: All reviewers must read the reviewing guide and agree to follow the project review guidelines.

Code of Conduct

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