Skip to content

patrickzheng200/oras-go

 
 

Repository files navigation

ORAS Go library

ORAS

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.

v1: stable

Build Status Go Report Card GoDoc

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

If you are seeking stability over new features, you are highly encouraged to use releases with major version 1.

v2: experimental

Build Status codecov Go Report Card GoDoc

In contrast to the v1 branch, the main branch is where all new feature development will occur. Since ORAS is a primary staging ground for the ORAS Artifacts Specification, changes are expected to occur regularly to meet new requirements. Any backward-incompatible changes will follow our versioning policy and be reserved for the next major version of the library (2), which users may opt into.

Examples for common use cases can be found below:

If you are seeking new features over stability, you should use the main branch (or a specific commit hash) when including the ORAS Go library in your project's go.mod.

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

Docs

Code of Conduct

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

Packages

No packages published

Languages

  • Go 99.9%
  • Makefile 0.1%