-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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.
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
Add latest_prerelease Docker Hub tag for following the latest alpha release #3465
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome. Thanks. LGTM - Will leave it a day or two to give other maintainers a chance to voice any thoughts etc.
We don't do pre-relaases that often.
@@ -10,6 +10,9 @@ _Black_ images with the following tags are available: | |||
- `latest_release` - tag created when a new version of _Black_ is released.\ | |||
ℹ Recommended for users who want to use released versions of _Black_. It maps to [the latest release](https://github.com/psf/black/releases/latest) | |||
of _Black_. | |||
- `latest_prerelease` - tag created when a new alpha (prerelease) version of _Black_ is | |||
released.\ | |||
ℹ Recommended for users who want to preview or test alpha versions of _Black_. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One concern here is that we don't usually use prereleases, we're just doing it right now as we're preparing for the 23.1 release. I'm expecting that for the rest of 2023 we won't have any prereleases, then we'll have 24.1a releases again in December 2023. So I think we should at least call out here that there may be a release that's more recent than the latest prerelease.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call. I did think of this but thought people could deal with it. But being more explicit is only going to help.
Maybe just call it prerelease and state it's only planned generally once a year for testing --preview
moving into releases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's good to know, and from a documentation standpoint I think it fits best in the Release Process docs. Currently there's no mention there of alpha versions or this yearly process, and if there's a thought that this will happen each December, it might be a good addition there.
Then, this bit here can be a bit more specific and possibly also point to the release process docs for more detail.
Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That makes sense! I kind of came up with this alpha process on the fly because I thought it'd be helpful. However, writing that new documentation would be a bigger change that's outside the scope of this PR, so for now we can just have a brief note here like "Note that the most recent release may be newer than any prerelease."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added, take a gander at that whenever you have a second
…d. At some point, more release process docs to follow on the Alphas
Co-authored-by: Jelle Zijlstra <[email protected]>
Thanks @matthewarmand for your contribution! |
No worries at all @JelleZijlstra, thanks for the feedback and the support. Just to tie this off, there is still the suggestion of linking directly to the Docker Image docs from the Docker Hub overview; again I didn't see that source in this repo so if maintainers like that idea someone would probably need to go update that manually on https://hub.docker.com/r/pyfound/black. Thanks again, I really appreciate your extremely timely support and attention. |
…elease (psf#3465) Co-authored-by: Jelle Zijlstra <[email protected]>
Description
Over here, #3453 (comment) while fixing an issue with the Docker image publishing workflow, it seemed there's a legitimate desire for a docker tag which follows alpha (prerelease) releases of Black. This PR creates a new tag to be pushed to Docker Hub going forward (
latest_prerelease
which will be updated with every alpha version release.I do have another change to request along with this...
If someone comes across the official Black image on Docker Hub, the description is a shortened version of the README with a link to the full docs. There isn't an obvious pointer to the documentation of which Docker image tags are in use and for what purpose. I don't think duplicating the information there is necessarily the right way to go (unless it's sourced in this repository), but having another explicit link to that specific docs page would grease the wheels just a bit for folks discovering it on Docker Hub.
I don't see where in the source code that Description on DockerHub is maintained, and so I think it's probably been manually set by a maintainer. Linking to Black's Full Documentation still makes sense to me, but I think an additional line just above that would be helpful, something like the following:
Checklist - did you ...
CHANGES.md
if necessary?