Skip to content

feat: add release channel tag to image #17287

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

Closed
wants to merge 10 commits into from
Closed

feat: add release channel tag to image #17287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e0548a0
feat: add release channel tag to image
Zoupers Mar 22, 2025
e8a6713
Merge branch 'coder:main' into main
Zoupers Mar 25, 2025
b2af545
Merge branch 'coder:main' into main
Zoupers Apr 6, 2025
d00185d
Merge branch 'main' into main
Zoupers Apr 8, 2025
1ca50d0
Update scripts/image_tag.sh
Zoupers Apr 9, 2025
aeaf1ba
Update .github/workflows/release.yaml
Zoupers Apr 9, 2025
c30dda6
update according to suggestions
Zoupers Apr 9, 2025
b779f83
left something...
Zoupers Apr 9, 2025
cb44735
left something...
Zoupers Apr 9, 2025
6c705bf
Update scripts/image_tag.sh
Zoupers Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,11 @@ jobs:
else
echo "created_latest_tag=false" >> $GITHUB_OUTPUT
fi
# push image based on current channel
Copy link
Member

Choose a reason for hiding this comment

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

@stirby This will break when you do a backport to an older version right? I thought I'd ping you since you know more about the channels than I do.

e.g. if the current stable tag is v2.2.0 and you create v2.1.1 as "stable" then it will overwrite stable with an older version

Copy link
Member

Choose a reason for hiding this comment

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

If this is the case then it severely complicates things and we'll need to do something like we do with the git tag semver stuff above (but we can't just copy and paste that otherwise stable won't work)

Copy link
Author

Choose a reason for hiding this comment

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

I checked the release history, and found there does exists this situation. For example, v2.14.4 is released after v2.15.3.

Copy link
Member

Choose a reason for hiding this comment

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

Yep, not sure how we even go about fixing these. When we do something like the git tag thing above, it'd need to filter by the current channel (but that metadata isn't stored in Git AFAIK, only in github releases)

Copy link
Author

Choose a reason for hiding this comment

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

I think it might be better to have tag like v2.14 and leave stable to the latest stable version ?

Copy link
Member

Choose a reason for hiding this comment

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

Even if we did that there's still not an easy way to determine if there is a "higher" stable version. When releasing v2.14.4, we would want it to detect v2.15.3 as a "higher" stable version. But if there are only mainline versions higher than the current version, we'd still want to update the stable tag.

Copy link
Author

Choose a reason for hiding this comment

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

How about introduce a new parameter to manage the stable and mainline tag in release.yml?

Copy link
Author

@Zoupers Zoupers Apr 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Or we can introduce a version file in the repo which tells if the version is stable. Then we can check the latest stable version.

It should be easy to manage, we just need to add version to it while we are running a stable release.

But the branches we need to commit to seems not that easy to determine.

Copy link
Member

Choose a reason for hiding this comment

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

I also think we have another problem when we promote mainline to stable since we don't do anything in github/git other than changing the release notes I imagine.

@stirby

Copy link
Collaborator

Choose a reason for hiding this comment

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

I can verify the issues that @deansheather mentioned make it difficult to accept the current implementation. This is certainly something we want to fix but don't have the resources right now.

Down the road we can do our stable releases and promotion more intelligently to support this, but our workflow can't handle this change currently.

./scripts/build_docker_multiarch.sh \
--push \
--target "$(./scripts/image_tag.sh --version "$CODER_RELEASE_CHANNEL")" \
$(cat build/coder_"$version"_linux_{amd64,arm64,armv7}.tag)
env:
CODER_BASE_IMAGE_TAG: ${{ steps.image-base-tag.outputs.tag }}

Expand Down
7 changes: 4 additions & 3 deletions scripts/image_tag.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
# the image tag for the multi-arch image will be returned instead.
#
# If no version is specified, defaults to the version from ./version.sh. If the
# supplied version is "latest", no `v` prefix will be added to the tag.
# supplied version is one of "latest", "mainline", "stable", no `v` prefix will
# be added to the tag.
#
# The returned tag will be sanitized to remove invalid characters like the plus
# sign.
Expand Down Expand Up @@ -56,8 +57,8 @@ tag_prefix="${CODER_IMAGE_TAG_PREFIX:-}"

tag="${tag_prefix:+$tag_prefix-}v$version"

if [[ "$version" == "latest" ]]; then
tag="latest"
if [[ "$version" == "latest" ]] || [[ "$version" == "mainline" ]] || [[ "$version" == "stable" ]]; then
tag="$version"
fi

if [[ "$arch" != "" ]]; then
Expand Down