Skip to content

docs: require explicit docker image versions - #1576

Merged
kw-tmueller merged 3 commits into
10.16from
docs/explicit-image-version-10.16
Jul 31, 2026
Merged

docs: require explicit docker image versions#1576
kw-tmueller merged 3 commits into
10.16from
docs/explicit-image-version-10.16

Conversation

@DeepDiver1975

@DeepDiver1975 DeepDiver1975 commented Jul 30, 2026

Copy link
Copy Markdown
Member

Every documented owncloud/server reference on this branch now carries an
explicit version tag, and latest is no longer presented as a valid option.

owncloud/server:latest does not track the release line documented here — it
follows whatever the newest published image happens to be — so a reader copying
the examples, or a container restart, can end up on a different version than the
documentation describes. There are also no rolling major or minor tags
(owncloud/server:10.16 and :10 both 404 on Docker Hub), so a full version is
the only correct thing to name.

This applies to owncloud/server only. An earlier revision of this PR also
pinned the selenium and inbucket images in the UI testing guide; those pins are
reverted, since they fix no documented-version mismatch and nothing in this repo
keeps them current.

Changes

modules/admin_manual/pages/installation/docker/index.adoc

  • Adds a docker-image-version page attribute set to the literal 10.16.4.
    This intentionally does not reuse {latest-server-version} or
    {latest-server-download-version}: those are global site attributes that track
    the latest release of the product, and the value that wins is the aggregator's
    (owncloud/docs global-attributes.yml), not this branch's antora.yml. The
    page currently renders OWNCLOUD_VERSION=10.16 for that reason, and once the
    global attribute moves to the 11 line it would render an image tag that has
    nothing to do with this branch.
  • Tags the quick-evaluation docker run (owncloud/server:10.16.4); it was
    untagged, which resolves to latest.
  • OWNCLOUD_VERSION in the .env example and in the required-settings table now
    names the explicit version, and the table no longer offers latest.
  • Adds a note explaining why OWNCLOUD_VERSION must be pinned.

modules/admin_manual/pages/useful_pages.adoc

  • Fixes the xrefs into the latest server version, which the page deliberately
    targets but addressed with this branch's page paths. The 11.0 release is
    docker-only and reorganized accordingly, so three of the five links break as
    soon as latest-server-version advances.

Testing

npm run antora-local (Node 22, as pinned by this branch's ci.yml) builds with
only the two pre-existing ocis:admin: cross-component xref errors, which are
unrelated and cannot resolve in a single-repo build. The rendered page shows
OWNCLOUD_VERSION=10.16.4, owncloud/server:10.16.4, and no occurrence of
latest in the settings table. The 10.16.4 tag was verified present on Docker
Hub.

The same change is being made on master (#1575, where the
page is installing_with_docker.adoc) and on 10.15.

Every documented image reference now carries an explicit version tag and
the `latest` tag is no longer offered as an option. `owncloud/server:latest`
does not necessarily point to the release line documented on this branch,
so a container restart can silently pull a different version.

The docker page uses a literal `docker-image-version` page attribute rather
than one of the global `-version` attributes: those track the latest release
of the product, which is not this branch, so interpolating them here would
document an image that does not belong to this release line.

Also pin the selenium and inbucket images in the UI testing guide, matching
the chrome pins the page already carries for owncloud/core#35444.

Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
phil-davis
phil-davis previously approved these changes Jul 30, 2026
The page deliberately links into the *latest* server version rather than this
branch, but it used this branch's page paths. The 11.0 release is docker-only
and reorganized accordingly: `installation/index.adoc` (manual installation) is
gone, the docker page moved from `installation/docker/index.adoc` to
`installation/installing_with_docker.adoc`, and `maintenance/manual_upgrade.adoc`
moved under `maintenance/upgrading/`.

Three of the five links therefore break as soon as `latest-server-version`
advances to 11.0, which fails the aggregated site build. Point them at the paths
that exist there and drop the manual installation entry, which has no 11.0
equivalent.

Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
The explicit-version requirement is about `owncloud/server` only: its `latest`
tag does not track the release line documented here and there are no rolling
major or minor tags, so following it installs a version the docs do not
describe.

That reasoning does not carry over to the selenium and inbucket images used by
the UI test setup. Pinning them fixes no documented-version mismatch and only
adds pins that nothing in this repo keeps current, so restore them to their
previous untagged form. The two `standalone-chrome*` pins stay, they predate
this and exist because of owncloud/core#35444.

Signed-off-by: Thomas Müller <1005065+DeepDiver1975@users.noreply.github.com>
@kw-tmueller
kw-tmueller merged commit ae7fe8e into 10.16 Jul 31, 2026
3 checks passed
@kw-tmueller
kw-tmueller deleted the docs/explicit-image-version-10.16 branch July 31, 2026 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants