{"id":13471900,"url":"https://github.com/opencontainers/distribution-spec","last_synced_at":"2025-05-13T18:14:59.862Z","repository":{"id":37390509,"uuid":"124432155","full_name":"opencontainers/distribution-spec","owner":"opencontainers","description":"OCI Distribution Specification","archived":false,"fork":false,"pushed_at":"2025-04-16T22:53:26.000Z","size":938,"stargazers_count":925,"open_issues_count":95,"forks_count":220,"subscribers_count":48,"default_branch":"main","last_synced_at":"2025-05-10T23:31:39.896Z","etag":null,"topics":["containers","docker","oci"],"latest_commit_sha":null,"homepage":"https://opencontainers.org","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opencontainers.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":"GOVERNANCE.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-03-08T18:32:40.000Z","updated_at":"2025-05-10T19:08:48.000Z","dependencies_parsed_at":"2023-10-13T09:08:53.538Z","dependency_job_id":"77f7f3b8-db97-40a0-886c-145b5cfe97ba","html_url":"https://github.com/opencontainers/distribution-spec","commit_stats":{"total_commits":274,"total_committers":77,"mean_commits":"3.5584415584415585","dds":0.8795620437956204,"last_synced_commit":"66bd6f563d0b1fcf660ee4845b200e7f89ed6838"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencontainers%2Fdistribution-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencontainers%2Fdistribution-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencontainers%2Fdistribution-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencontainers%2Fdistribution-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opencontainers","download_url":"https://codeload.github.com/opencontainers/distribution-spec/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253708101,"owners_count":21951052,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["containers","docker","oci"],"created_at":"2024-07-31T16:00:50.157Z","updated_at":"2025-05-13T18:14:59.840Z","avatar_url":"https://github.com/opencontainers.png","language":"Go","funding_links":[],"categories":["Go","Specifications:","docker","CNAB"],"sub_categories":[],"readme":"# OCI Distribution Specification\n\n[![GitHub Actions status](https://github.com/opencontainers/distribution-spec/workflows/build/badge.svg)](https://github.com/opencontainers/distribution-spec/actions?query=workflow%3Abuild)\n\nThe OCI Distribution Spec project defines an API protocol to facilitate and standardize the distribution of content.\n\n**[The specification can be found here](spec.md).**\n\nThis repository also provides [Go types](specs-go), and [registry conformance tooling](conformance).\nThe Go types and validation should be compatible with the current Go release; earlier Go releases are not supported.\n\nAdditional documentation about how this group operates:\n\n- [Contributing](CONTRIBUTING.md)\n- [Governance](GOVERNANCE.md)\n- [Maintainers' Guide](MAINTAINERS_GUIDE.md)\n- [Releases](RELEASES.md)\n- [OCI Values](https://github.com/opencontainers/tob/blob/main/CHARTER.md#7-oci-values)\n\n## Distributing OCI Images and other content\n\nThe OCI Distribution Spec is closely related to the [OCI Image Format Specification] project and the [OCI Runtime Specification] project.\n\nThe [OCI Image Format Specification] strictly defines the requirements for an OCI Image (container image), which consists of\na manifest, an optional image index, a set of filesystem layers, and a configuration.\nThe schema for OCI Image components is fully supported by the APIs defined in the OCI Distribution Specification.\n\nThe [OCI Runtime Specification] defines how to properly run a container \"[filesystem bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md)\"\nwhich fully adheres to the OCI Image Format Specification. The OCI Runtime Specification is relevant to the OCI Distribution Specification in that they both support OCI Images,\nand that container runtimes use the APIs defined in the OCI Distribution Specification to fetch pre-built container images and run them.\n\nThe [OCI Distribution Specification] (this project) is also designed generically enough to be leveraged as a distribution mechanism for\nany type of content. The format of uploaded manifests, for example, need not necessarily adhere to the OCI Image Format Specification\nso long as it references the blobs which comprise a given artifact.\n\n[OCI Image Format Specification]: https://github.com/opencontainers/image-spec\n[OCI Runtime Specification]: https://github.com/opencontainers/runtime-spec\n[OCI Distribution Specification]: https://github.com/opencontainers/distribution-spec\n\n## FAQ\n\nFor questions about the OCI Distribution Specification, please see the [FAQ](FAQ.md).\n\nFor general questions about OCI, please see the [FAQ on the OCI site](https://www.opencontainers.org/faq).\n\n## Roadmap\n\nThe [GitHub milestones](https://github.com/opencontainers/distribution-spec/milestones) lay out the path to the future improvements.\n\n# Extensions\n\nThe Distribution Specification Project includes a process and API for prototyping\nand testing extensions to the Distribution API.\n\nWe invite contributions, comments, and reviews to these extensions.\nThese extensions will only move forward with significant support from registries, registry clients, and users.\n\nPlease see [here](https://github.com/opencontainers/distribution-spec/blob/main/extensions/README.md) for more details.\n\n# Contributing\n\nDevelopment happens on GitHub for the spec.\nIssues are used for bugs and actionable items and longer discussions can happen on the [mailing list](#mailing-list).\n\nThe specification and code is licensed under the Apache 2.0 license found in the `LICENSE` file of this repository.\n\n## Discuss your design\n\nThe project welcomes submissions, but please let everyone know what you are working on.\n\nBefore undertaking a nontrivial change to this specification, send mail to the [mailing list](#mailing-list) to discuss what you plan to do.\nThis gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits.\nIt also guarantees that the design is sound before code is written; a GitHub pull-request is not the place for high-level discussions.\n\nTypos and grammatical errors can go straight to a pull-request.\nWhen in doubt, start on the [mailing-list](#mailing-list).\n\n## Meetings\n\nPlease see the [OCI org repository README](https://github.com/opencontainers/org#meetings) for the most up-to-date information on OCI contributor and maintainer meeting schedules.\nYou can also find links to meeting agendas and minutes for all prior meetings.\n\n## Mailing List\n\nYou can subscribe and join the mailing list on [Google Groups](https://groups.google.com/a/opencontainers.org/forum/#!forum/dev).\n\n## Chat\n\nOCI discussion happens in the following chat rooms, which are all bridged together:\n\n- #general channel on [OCI Slack](https://opencontainers.org/community/overview/#chat)\n- #opencontainers:matrix.org\n\n## Markdown style\n\nTo keep consistency throughout the Markdown files in the Open Container spec all files should be formatted one sentence per line.\nThis fixes two things: it makes diffing easier with git and it resolves fights about line wrapping length.\nFor example, this paragraph will span three lines in the Markdown source.\n\n## Git commit\n\n### Sign your work\n\nThe sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch.\nThe rules are pretty simple: if you can certify the below (from [developercertificate.org](http://developercertificate.org/)):\n\n```\nDeveloper Certificate of Origin\nVersion 1.1\n\nCopyright (C) 2004, 2006 The Linux Foundation and its contributors.\n660 York Street, Suite 102,\nSan Francisco, CA 94110 USA\n\nEveryone is permitted to copy and distribute verbatim copies of this\nlicense document, but changing it is not allowed.\n\n\nDeveloper's Certificate of Origin 1.1\n\nBy making a contribution to this project, I certify that:\n\n(a) The contribution was created in whole or in part by me and I\n    have the right to submit it under the open source license\n    indicated in the file; or\n\n(b) The contribution is based upon previous work that, to the best\n    of my knowledge, is covered under an appropriate open source\n    license and I have the right under that license to submit that\n    work with modifications, whether created in whole or in part\n    by me, under the same open source license (unless I am\n    permitted to submit under a different license), as indicated\n    in the file; or\n\n(c) The contribution was provided directly to me by some other\n    person who certified (a), (b) or (c) and I have not modified\n    it.\n\n(d) I understand and agree that this project and the contribution\n    are public and that a record of the contribution (including all\n    personal information I submit with it, including my sign-off) is\n    maintained indefinitely and may be redistributed consistent with\n    this project or the open source license(s) involved.\n```\n\nthen you just add a line to every git commit message:\n\n    Signed-off-by: Jane Smith \u003cjane@gmail.com\u003e\n\nusing your real name (sorry, no pseudonyms or anonymous contributions.)\n\nYou can add the sign off when creating the git commit via `git commit -s`.\n\n### Commit Style\n\nSimple house-keeping for clean git history.\nRead more on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) or the Discussion section of [`git-commit(1)`](http://git-scm.com/docs/git-commit).\n\n1. Separate the subject from body with a blank line\n2. Limit the subject line to 50 characters\n3. Capitalize the subject line\n4. Do not end the subject line with a period\n5. Use the imperative mood in the subject line\n6. Wrap the body at 72 characters\n7. Use the body to explain what and why vs. how\n* If there was important/useful/essential conversation or information, copy or include a reference\n8. When possible, one keyword to scope the change in the subject (i.e. \"README: ...\", \"runtime: ...\")\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencontainers%2Fdistribution-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopencontainers%2Fdistribution-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencontainers%2Fdistribution-spec/lists"}