Skip to content
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

Jump to bottom

Docker, docs: Document and implement changed image tagging policy #1014

Merged
merged 5 commits into from
Apr 28, 2024
Merged

Docker, docs: Document and implement changed image tagging policy #1014

merged 5 commits into from
Apr 28, 2024

Conversation

ix5
Copy link
Member

@ix5 ix5 commented Apr 21, 2024 •
edited
Loading

Checklist

  • All new and existing tests are passing
  • (If adding features:) I have added tests to cover my changes
  • (If docs changes needed:) I have updated the documentation accordingly.
  • I have added an entry to CHANGES.rst because this is a user-facing change or an important bugfix
  • I have written proper commit message(s)

What changes does this Pull Request introduce?

  • :latest is now used for auto-pushed images off of master, while :release will follow the latest tagged stable release.
  • Use org.opencontainers.* docker LABEL metadata to connect images to our GitHub source

Why is this necessary?

#1012

@ix5 ix5 added docs Documentation of the project meta Concerning the general direction and organisation of the project labels Apr 21, 2024
@ix5 ix5 added this to the 0.14 milestone Apr 21, 2024
@ix5 ix5 mentioned this pull request Apr 21, 2024
Closed
3 tasks
ix5 added 2 commits April 22, 2024 01:44
@ix5
Dockerfile: Add LABELs
66a2591 
This helps connect the image with the package registry
metadata.
@ix5
.github/docker: Discard empty workflow meta labels
7c43a77 
Instead use the Dockerfile LABELs
@jelmer
Copy link
Member

jelmer commented Apr 22, 2024

Please update the :release tag from the CI - I don't think the current PR does that.

jelmer
jelmer reviewed Apr 22, 2024
View reviewed changes
CHANGES.rst Show resolved Hide resolved
Dockerfile Show resolved Hide resolved
docs/docs/reference/installation.rst Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
ix5 added 2 commits April 23, 2024 20:33
@ix5
docs, README: Document changed docker image tagging
d4dc6e4 
`:latest` is now used for auto-pushed images off of
`master`, while `:release` will follow the latest tagged
stable release.
@ix5
Makefile: Clarify, add docker-release targets
ba7c6d5
@jelmer jelmer self-assigned this Apr 24, 2024
jelmer
jelmer requested changes Apr 24, 2024
View reviewed changes
Copy link
Member

@jelmer jelmer left a comment

Choose a reason for hiding this comment

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

LGTM, one comment:

Please update the :release tag from the CI - I don't think the current PR does that.

@ix5
.github/docker-build: Tag ':release' on git tags
1544b34 
Caution: This tags the docker image `:release` on _every_
git push containing tags!
@ix5
Copy link
Member Author

ix5 commented Apr 28, 2024

LGTM, one comment:

Please update the :release tag from the CI - I don't think the current PR does that.

I've added 1544b34 .github/docker-build: Tag ':release' on git tags which additionally tags the newly built docker image with :release if the GitHub Actions event type is tag (github.ref_type == 'tag').

@jelmer, you will have to remember this in case you want to push debian/*-namespaced tags. I'm not in the mood to dig further into GitHub Actions' YAML-based expression evaluation to make this action smarter (e.g. only tag the docker image if tag matches semver AND the version is the "highest" out of all tags).

@ix5 ix5 enabled auto-merge April 28, 2024 22:16
@ix5 ix5 disabled auto-merge April 28, 2024 22:17
@ix5 ix5 merged commit dc11434 into isso-comments:master Apr 28, 2024
15 of 16 checks passed
@ix5 ix5 deleted the docker-labels branch April 28, 2024 22:18
@ix5
Copy link
Member Author

ix5 commented Apr 28, 2024

CI is failing for the compare-screenshots step because I rebuilt and pushed the testbed image for node-related stuff - will fix in another PR.

@ix5 ix5 modified the milestones: 0.14, 0.13.1 May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jelmer jelmer jelmer approved these changes

Assignees

@jelmer jelmer

Labels
docs Documentation of the project meta Concerning the general direction and organisation of the project
Projects
None yet
Milestone
0.13.1
Development

Successfully merging this pull request may close these issues.
2 participants
@ix5 @jelmer