Skip to content

docs: define container image tagging convention - #54

Open
Voyagerroc-Lab wants to merge 1 commit into
LibreCodeCoop:mainfrom
Voyagerroc-Lab:docs/image-tagging-convention
Open

docs: define container image tagging convention#54
Voyagerroc-Lab wants to merge 1 commit into
LibreCodeCoop:mainfrom
Voyagerroc-Lab:docs/image-tagging-convention

Conversation

@Voyagerroc-Lab

Copy link
Copy Markdown

Summary

Closes #53. Document the existing app and web image components, stable and master channels, moving and immutable tags, runtime variants, OCI traceability metadata, and concrete examples. Link the new reference from the README.

This is documentation-only and does not change existing image names, tags, Dockerfiles, or publishing workflows.

@vitormattos vitormattos left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution.

I left a few inline comments to align the documentation with #53.

The DCO check is also failing. Please follow the instructions from the DCO workflow and update the commit with the required sign-off.

Comment thread docs/image-tagging.md
Comment on lines +13 to +15
Stable images use the Nextcloud release version as the channel tag, for example
`app:31` or `app:31.0.4`. A major tag is moving and follows the latest compatible
patch release. A full version tag is immutable after publication.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make the moving and immutable stable tags explicit here.

I suggest replacing this paragraph with:

Stable images use Nextcloud versions for their tags. A major-version tag, such as 31, is a moving alias that follows the latest compatible patch release. A full version tag, such as 31.0.4, is immutable after publication.

Comment thread docs/image-tagging.md
- `org.opencontainers.image.revision`: the source commit;
- `org.opencontainers.image.created`: the build timestamp;
- `org.opencontainers.image.version`: the Nextcloud version or `master` revision;
- `org.opencontainers.image.base.name`: the runtime base image.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue requires traceability metadata for the PHP version and runtime variant, but they are missing here.

Please add these two items after the OCI labels and make it clear that they use project-specific metadata because there is no standard OCI label defined here for them:

  • PHP version;
  • runtime variant, such as apache or fpm.

Please keep them clearly separated from the standard org.opencontainers.image.* labels above.

Comment thread docs/image-tagging.md
Comment on lines +53 to +54
ghcr.io/librecodecoop/nextcloud-docker-web:31-apache
ghcr.io/librecodecoop/nextcloud-docker-web:master-fpm

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apache and FPM are valid runtime variants for the application image, but these examples attach them to the web image.

The current web component is the separate nginx image. Please change these two examples to:

ghcr.io/librecodecoop/nextcloud-docker-app:31-apache
ghcr.io/librecodecoop/nextcloud-docker-app:master-fpm

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.

Document the container image naming and tagging convention

2 participants