diff --git a/README.md b/README.md index 2d3c661e9db..4970cd9aff6 100644 --- a/README.md +++ b/README.md @@ -125,18 +125,23 @@ The canonical download instructions for IPFS are over at: https://docs.ipfs.tech ### Docker -Official images are published at https://hub.docker.com/r/ipfs/kubo/: +Official images are published at https://hub.docker.com/r/ipfs/kubo/: [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/ipfs/kubo?color=blue&label=kubo%20docker%20image&logo=docker&sort=semver&style=flat-square&cacheSeconds=3600)](https://hub.docker.com/r/ipfs/kubo/) -[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/ipfs/kubo?color=blue&label=kubo%20docker%20image&logo=docker&sort=semver&style=flat-square&cacheSeconds=3600)](https://hub.docker.com/r/ipfs/kubo/) +#### 🟢 Release Images + - These are production grade images. Use them. + - `latest` and [`release`](https://hub.docker.com/r/ipfs/kubo/tags?name=release) tags always point at [the latest stable release](https://github.com/ipfs/kubo/releases/latest). If you use this, remember to `docker pull` periodically to update. + - [`vN.N.N`](https://hub.docker.com/r/ipfs/kubo/tags?name=v) points at a specific [release tag](https://github.com/ipfs/kubo/releases) -- 🟢 Releases - - `latest` and `release` tags always point at [the latest stable release](https://github.com/ipfs/kubo/releases/latest) - - `vN.N.N` points at a specific [release tag](https://github.com/ipfs/kubo/releases) - - These are production grade images. -- 🟠 We also provide experimental developer builds - - `master-latest` always points at the `HEAD` of the `master` branch - - `master-YYYY-DD-MM-GITSHA` points at a specific commit from the `master` branch +#### 🟠 Developer Preview Images - These tags are used by developers for internal testing, not intended for end users or production use. + - [`master-latest`](https://hub.docker.com/r/ipfs/kubo/tags?name=master-latest) always points at the `HEAD` of the [`master`](https://github.com/ipfs/kubo/commits/master/) branch + - [`master-YYYY-DD-MM-GITSHA`](https://hub.docker.com/r/ipfs/kubo/tags?name=master-2) points at a specific commit from the `master` branch + +#### 🔴 Internal Staging Images + - We use `staging` for testing arbitrary commits and experimental patches. + - To build image for current HEAD, force push to `staging` via `git push origin HEAD:staging --force`) + - [`staging-latest`](https://hub.docker.com/r/ipfs/kubo/tags?name=staging-latest) always points at the `HEAD` of the [`staging`](https://github.com/ipfs/kubo/commits/staging/) branch + - [`staging-YYYY-DD-MM-GITSHA`](https://hub.docker.com/r/ipfs/kubo/tags?name=staging-2) points at a specific commit from the `staging` branch ```console $ docker pull ipfs/kubo:latest