Skip to content

Upgrade readme with new docker images #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 2 additions & 26 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,32 +41,8 @@ Releases
--------

These images are all built from our `automated Docker Hub repository`_. The
automated build rules include pattern matching on Git tags. Here is how the
images are currently tagged:

build:latest
This is the latest supported release. Currently, this is ``3.0``.

build:stable
This is the previously supported release. Currently, this is ``2.0``.

build:4.0rc1
This is the next image being released, it will go through a testing cycle
before being considered a full release however. It is only a release
candidate currently, and is not useable on Read the Docs until full release.
This is the version built from ``master`` currently.

build:3.0
From any tag matching ``3.0[0-9.]*``. These tags should only represent
commits to the ``releases/3.x`` branch.

build:2.0
From any tag matching ``2.0[0-9.]*``. These tags should only represent
commits to the ``releases/2.x`` branch.

build:1.0
From the ``1.0`` tag. These tags should only represent commits to the
``releases/1.x`` branch.
automated build rules include pattern matching on Git tags. The current tags
are defined in the :doc:`README`.

We follow `semantic versioning`_, but drop the bug fix level version number for
our images, as this level of granularity is not important for any application of
Expand Down
13 changes: 9 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,21 @@ repository:
Ubuntu 16.04 based image.

`readthedocs/build:4.0`
``stable``
**Deprecated**
Ubuntu 18.04 supporting Python 2.7, 3.5, 3.6, 3.7.
This is the **stable** image supported by Read the Docs.

`readthedocs/build:5.0`
``latest``
``stable``
Ubuntu 18.04 supporting Python 2.7, 3.6, 3.7 and pypy3.5-7.0.0.
This is the **stable** image supported by Read the Docs.

`readthedocs/build:6.0`
``latest``
Ubuntu 18.04 supporting Python 2.7, 3.5, 3.6, 3.7, 3.8 and PyPy3.5-7.0.0.
This is the **latest** default image used for documentation builds and supported by Read the Docs.

`readthedocs/build:6.0rc1`
`readthedocs/build:7.0`
``testing``
Ubuntu 18.04 supporting Python 2.7, 3.5, 3.6, 3.7, 3.8 and PyPy3.5-7.0.0.
For internal development **testing** only, not available for public usage yet.

Expand Down