cllarify release branches and timeline

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
This commit is contained in:
Bobby DeSimone 2019-08-05 13:37:20 -07:00
parent 55a97fabd4
commit 351bf2fd53
No known key found for this signature in database
GPG key ID: AEE4CF12FE86D07E

View file

@ -6,12 +6,22 @@ Official binaries for OSX, Windows, and Linux can be found on our [Github Releas
## Docker
Pomerium is also distributed as a [lightweight](https://github.com/GoogleContainerTools/distroless) [docker container](https://www.docker.com/resources/what-container). You can find Pomerium's images on [dockerhub](https://hub.docker.com/r/pomerium/pomerium) for both AMD64 and a few other architectures. In addition to tagged releases, you can run `latest` which is kept in sync with [master](https://github.com/pomerium/pomerium/tree/master).
Pomerium is also distributed as a [minimal](https://github.com/GoogleContainerTools/distroless) [docker container](https://www.docker.com/resources/what-container). You can find Pomerium's images on [dockerhub](https://hub.docker.com/r/pomerium/pomerium). Pomerium can be pulled in several flavors and architectures.
```bash
$ docker run pomerium/pomerium:v0.1.0 --version
v0.1.0+53bfa4e
```
- `:vX.Y.Z`: which will pull the a [specific tagged release](https://github.com/pomerium/pomerium/tags).
```bash
$ docker run pomerium/pomerium:v0.1.0 --version
v0.1.0+53bfa4e
```
* `:latest`: which will pull the [most recent tagged release](https://github.com/pomerium/pomerium/releases).
```bash
$ docker pull pomerium/pomerium:latest && docker run pomerium/pomerium:latest --version
v0.2.0+87e214b
```
- `:master` : which will pull an image in sync with git's [master](https://github.com/pomerium/pomerium/tree/master) branch.
## Source
@ -26,7 +36,7 @@ make
## Release Cycle
The current release cycle is aligned on a monthly basis. Pre-`1.0.0` we target a `MINOR` release on or around the **last day of each month**. We try to hit the targets as closely as possible, while still delivering a quality release.
The current release cycle is aligned on a monthly basis. Pre-`1.0.0` we target a `MINOR` release on or around the **first day of each month**. We try to hit the targets as closely as possible, while still delivering a quality release.
## Versioning
@ -39,3 +49,12 @@ Pomerium uses [Semantic Versioning](https://semver.org/). In practice this means
As Pomerium is still pre-`v1.0.0`, breaking changes between releases should be expected.
To see difference between releases, please refer to the changelog and upgrading documents.
## Versioned Docs
For convenience, we maintain hosted documentation for each tagged release. The format for which is `https://{MAJOR}-{MINOR}-{PATCH}.docs.pomerium.io`. For example:
- [v0.2.0](https://0-2-0.docs.pomerium.io/)
- [v0.1.0](https://0-1-0.docs.pomerium.io/)
- [v0.0.5](https://0-0-5.docs.pomerium.io/)
- [v0.0.4](https://0-0-4.docs.pomerium.io/)