Skip to content

Remove LABEL version from Dockerfile and CONTRIBUTING guide #118

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.

Sign up for GitHub

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 1 commit into from
Apr 30, 2020
Merged

Remove LABEL version from Dockerfile and CONTRIBUTING guide #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 5 additions & 8 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,17 @@ 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
these images. Each release is tagged in Git, and the release version number is
included in the Dockerfile version label (``LABEL version="2.0"``).
these images.

Releases should be merged into one of the ``releases/`` branches, for instance
``releases/2.x``. The version label in the Dockerfile should be updated to the
next version in the series, following semver rules. This commit should then also
be tagged using the new version number.
``releases/2.x``. This commit should then also be tagged using the new version number.

If the version number in the Dockerfile was ``2.0.1`` before, and you implement
If the version number was ``2.0.1`` before, and you implement
a bug fix to the image, the new image will be ``2.0.2``. The output image from
Docker Hub will still be ``2.0`` however. If a new feature is introduced, the
new version tagged and in the Dockerfile will be ``2.1``.
new version tagged will be ``2.1``.

We don't care about bug fix version numbers here, as RTD will only ever have one
We don't care about bug fix version numbers here, as Read the Docs will only ever have one
main ``2.x`` image at a time. There is no need for us to run multiple bug fix
versions at the same time.

Expand Down
1 change: 0 additions & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Read the Docs - Environment base
FROM ubuntu:18.04
LABEL mantainer="Read the Docs <[email protected]>"
LABEL version="5.0.0"

ENV DEBIAN_FRONTEND noninteractive
ENV APPDIR /app
Expand Down