Skip to content

readme.md tagged version section is confusing #511

@nydydn

Description

@nydydn

What is the bug or the crash?

I believe that the readme is if not wrong, at least confusing:

It is mentioned that:

kartoza/postgis:17-3.5 Provides PostgreSQL 17.0, PostGIS 3.5

but currently this is false, as kartoza/postgis:17-3.5 provides PostgreSQL 17.4, PostGIS 3.5
I believe the intention was to mention that kartoza/postgis:17-3.5 Provides PostgreSQL 17.x, PostGIS 3.5

Further, there is the following note:

Note: We highly recommend that you use tagged versions because successive minor versions of PostgreSQL write their database clusters into different database directories - which will cause your database to appear to be empty if you are using persistent volumes for your database storage.

I don't think that is true. I believe that on successive major versions of PostgreSQL may change database directories and never minor versions. Isn't this the main difference between major and minor versions?

I really am no expert, so please correct me if I am grossly misunderstanding something and somehow the documentation is correct as it is.

Nevertheless, I believe one more paragraph of what an upgrade entails would be welcomed by novices. For example a note that says:

Upgrade between minor versions are done by pulling the latest tagged version, for example kartoza/postgis:17-3.5 might have contained 17.0 when first installed, but after being repulled it may contain 17.4 and the upgrade between minor versions will be done automatically.
Upgrade between major versions require dumping and re-importing data, please follow upgrade requirements on the PostgreSQL documentation.

Steps to reproduce the issue

  1. Check README.md
  2. Be confused about what version the tag 17-3.5 should provide, which is mentioned to be 17.0
  3. Check what gets installed when using tag 17-3.5, and observe it is 17.4, which is different from the documentation
  4. Check if database directories were restructured as mentioned in documentation for minor versions
  5. Observe that the upgrade was done successfully for minor versions, in spite of what the documentation mentions about upgrades between minor versions

Versions

17-3.5

Additional context

Technically this is not a bug, and it is neither a feature request, so I'm knowingly breaking the rules, but this would not have fitted on the postgres mailing list, or stackexchange either, as it is very much specific to this very github repository, even specific to a few lines of a file whose truth source is this repository. I believe it may alienate possible contributors to not welcome such reports, even if they're merely about documentation.

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