Skip to content

Explain the versioning of Docker images in the README #231

Open
@mcdonnnj

Description

@mcdonnnj

💡 Summary

We should explain the slight nuance of how we version Docker images in the README.

Motivation and context

As mentioned in #230 (comment) it was unclear why the image's version was only getting a bump to the build. The scenario with a Docker image containerizing a specific project is what led to this uncertainty and we should spell out more clearly in the README this approach to versioning.

Implementation notes

The README should explain versioning when containerizing a particular application vs. an image configuration that does a specific task. When containerizing the version is tied specifically to the version of the application being containerized. This means that changes which would otherwise cause a version bump (using a new version of Python in the image, etc.) only result in a bump of the build and not a minor or patch version bump. This is contrary to how we would version a Docker image that performs a particular task.

Acceptance criteria

  • The README correctly explains the different approaches to versioning in our Docker projects.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions