Skip to content

gha/release: Improve workflow input descriptions and ordering #307

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

Merged
vvoland merged 2 commits into from
Nov 4, 2025
Merged

gha/release: Improve workflow input descriptions and ordering #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76beb19
gha/release: Improve workflow input descriptions and ordering
vvoland Oct 31, 2025
d02efe7
gha/release: Default to "draft" type
vvoland Oct 31, 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
18 changes: 9 additions & 9 deletions .github/workflows/release-buildx.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,35 @@ on:
workflow_dispatch:
inputs:
ref:
description: 'Ref (e.g. v0.10.0)'
description: 'Tag/ref to build (e.g. v0.10.0)'
Copy link
Member

@thaJeztah thaJeztah Oct 31, 2025

Choose a reason for hiding this comment

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

Suggested change
description: 'Tag/ref to build (e.g. v0.10.0)'
description: 'Tag or git reference to build from (e.g. v0.10.0)'

Can we provide a valid non-tag example? I think this would also accept;

  • branch name
  • maybe refs/xx/xx/ (we could have a PR ref as example)
  • git sha
  • git describe format likely as well (e.g. api/v1.52.0-beta.3-36-g5680867af8)

Copy link
Collaborator Author

@vvoland vvoland Oct 31, 2025

Choose a reason for hiding this comment

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

I wouldn't encourage non-tag usage right now, as the VERSION string is derived from the reference.

So until we have an option to override the visible version (see #260) I wouldn't want to provide other examples than tags.

required: true
type: string
repo:
description: 'Override default repo'
required: false
type: string
release:
description: 'Release type'
description: '(optional) Release type to create in https://github.com/docker/packaging/releases'
Copy link
Member

@thaJeztah thaJeztah Oct 31, 2025

Choose a reason for hiding this comment

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

Perhaps a multi-line text block to also outline what the different options do;

- `pushonly` pushes the artifacts as an image, but does not create a (draft) release.
- `draft` pushes the artifacts as an image, and creates a draft release in  https://github.com/docker/packaging/releases
- ...

Copy link
Collaborator Author

@vvoland vvoland Oct 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Github doesn't render newlines/lists nicely in the workflow popup, so that would bloat the window too much I think:

image

required: false
default: 'pushonly'
default: 'draft'
Copy link
Member

@thaJeztah thaJeztah Oct 31, 2025

Choose a reason for hiding this comment

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

With a better description, do we perhaps want the default to be be kept pushonly? That makes it more of an explicit choice to decide what you want to do.

And .... maybe make that a required: true (need to pick something); is that possible with a choice? (does it have a none option?)

Copy link
Collaborator Author

@vvoland vvoland Oct 31, 2025

Choose a reason for hiding this comment

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

It was fine when testing, but now 99% cases you actually trigger it is for the actual deploy.

You can always delete the draft afterwards, but you can't easily regenerate the release if you do it as pushonly.

type: choice
options:
- pushonly
- draft
- prerelease
- release
distros:
description: 'Distros to build (comma-separated, e.g. "debian12,ubuntu2204")'
description: '(optional, empty = all supported) Distros to build (comma-separated, e.g. "debian12,ubuntu2204")'
required: false
type: string
default: ''
Comment on lines +25 to 28
Copy link
Member

@thaJeztah thaJeztah Oct 31, 2025

Choose a reason for hiding this comment

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

Wondering how long the list is, and if we could have / generate a checkbox-list for this 🤔

Copy link
Collaborator Author

@vvoland vvoland Oct 31, 2025

Choose a reason for hiding this comment

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

We should get rid of it after this one is merged: https://github.com/docker/release-repo/pull/727

revision:
description: |
Revision of the package to build. Only in case we ever would have to re-build an already published release with a packaging-only change.
(optional) Revision of the package to build. Only in case we ever would have to re-build an already published release with a packaging-only change.
Default for a tagged/upstream release is 1.
required: false
type: string
default: ''
repo:
description: '(optional) Override default repo (if want to build from a different Github repo/fork)'
required: false
type: string

jobs:
release:
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/release-cagent.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,21 @@ on:
workflow_dispatch:
inputs:
ref:
description: 'Ref (e.g. v0.1.30)'
description: 'Tag/ref to build (e.g. v0.1.30)'
required: true
type: string
repo:
description: 'Override default repo'
required: false
type: string
release:
description: 'Release type'
description: '(optional) Release type to create in https://github.com/docker/packaging/releases'
required: false
default: 'pushonly'
default: 'draft'
type: choice
options:
- pushonly
- draft
- prerelease
- release
distros:
description: 'Distros to build (comma-separated, e.g. "debian12,ubuntu22.04")'
description: '(optional, empty = all supported) Distros to build (comma-separated, e.g. "debian12,ubuntu2204")'
required: false
type: string
default: ''
Expand All @@ -37,6 +33,10 @@ on:
required: false
type: string
default: ''
repo:
description: '(optional) Override default repo (if want to build from a different Github repo/fork)'
required: false
type: string

jobs:
release:
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/release-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,21 @@ on:
workflow_dispatch:
inputs:
ref:
description: 'Ref (e.g. v2.15.1)'
description: 'Tag/ref to build (e.g. v2.15.1)'
required: true
type: string
repo:
description: 'Override default repo'
required: false
type: string
release:
description: 'Release type'
description: '(optional) Release type to create in https://github.com/docker/packaging/releases'
required: false
default: 'pushonly'
default: 'draft'
type: choice
options:
- pushonly
- draft
- prerelease
- release
distros:
description: 'Distros to build (comma-separated, e.g. "debian12,ubuntu22.04")'
description: '(optional, empty = all supported) Distros to build (comma-separated, e.g. "debian12,ubuntu2204")'
required: false
type: string
default: ''
Expand All @@ -37,6 +33,10 @@ on:
required: false
type: string
default: ''
repo:
description: '(optional) Override default repo (if want to build from a different Github repo/fork)'
required: false
type: string

jobs:
release:
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/release-containerd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,21 @@ on:
workflow_dispatch:
inputs:
ref:
description: 'Ref (e.g. v1.6.15)'
description: 'Tag/ref to build (e.g. v1.6.15)'
required: true
type: string
repo:
description: 'Override default repo'
required: false
type: string
release:
description: 'Release type'
description: '(optional) Release type to create in https://github.com/docker/packaging/releases'
required: false
default: 'pushonly'
default: 'draft'
type: choice
options:
- pushonly
- draft
- prerelease
- release
distros:
description: 'Distros to build (comma-separated, e.g. "debian12,ubuntu22.04")'
description: '(optional, empty = all supported) Distros to build (comma-separated, e.g. "debian12,ubuntu2204")'
required: false
type: string
default: ''
Expand All @@ -37,6 +33,10 @@ on:
required: false
type: string
default: ''
repo:
description: '(optional) Override default repo (if want to build from a different Github repo/fork)'
required: false
type: string

jobs:
release:
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/release-credential-helpers.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,21 @@ on:
workflow_dispatch:
inputs:
ref:
description: 'Ref (e.g. v1.7.0)'
description: 'Tag/ref to build (e.g. v1.7.0)'
required: true
type: string
repo:
description: 'Override default repo'
required: false
type: string
release:
description: 'Release type'
description: '(optional) Release type to create in https://github.com/docker/packaging/releases'
required: false
default: 'pushonly'
default: 'draft'
type: choice
options:
- pushonly
- draft
- prerelease
- release
distros:
description: 'Distros to build (comma-separated, e.g. "debian12,ubuntu22.04")'
description: '(optional, empty = all supported) Distros to build (comma-separated, e.g. "debian12,ubuntu2204")'
required: false
type: string
default: ''
Expand All @@ -37,6 +33,10 @@ on:
required: false
type: string
default: ''
repo:
description: '(optional) Override default repo (if want to build from a different Github repo/fork)'
required: false
type: string

jobs:
release:
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/release-docker-cli.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,21 @@ on:
workflow_dispatch:
inputs:
ref:
description: 'Ref (e.g. v23.0.0)'
description: 'Tag/ref to build (e.g. v23.0.0)'
required: true
type: string
repo:
description: 'Override default repo'
required: false
type: string
release:
description: 'Release type'
description: '(optional) Release type to create in https://github.com/docker/packaging/releases'
required: false
default: 'pushonly'
default: 'draft'
type: choice
options:
- pushonly
- draft
- prerelease
- release
distros:
description: 'Distros to build (comma-separated, e.g. "debian12,ubuntu22.04")'
description: '(optional, empty = all supported) Distros to build (comma-separated, e.g. "debian12,ubuntu2204")'
required: false
type: string
default: ''
Expand All @@ -37,6 +33,10 @@ on:
required: false
type: string
default: ''
repo:
description: '(optional) Override default repo (if want to build from a different Github repo/fork)'
required: false
type: string

jobs:
release:
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/release-docker-engine.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,21 @@ on:
workflow_dispatch:
inputs:
ref:
description: 'Ref (e.g. v23.0.0)'
description: 'Tag/ref to build (e.g. v23.0.0)'
required: true
type: string
repo:
description: 'Override default repo'
required: false
type: string
release:
description: 'Release type'
description: '(optional) Release type to create in https://github.com/docker/packaging/releases'
required: false
default: 'pushonly'
default: 'draft'
type: choice
options:
- pushonly
- draft
- prerelease
- release
distros:
description: 'Distros to build (comma-separated, e.g. "debian12,ubuntu22.04")'
description: '(optional, empty = all supported) Distros to build (comma-separated, e.g. "debian12,ubuntu2204")'
required: false
type: string
default: ''
Expand All @@ -37,6 +33,10 @@ on:
required: false
type: string
default: ''
repo:
description: '(optional) Override default repo (if want to build from a different Github repo/fork)'
required: false
type: string

jobs:
release:
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/release-model.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,21 @@ on:
workflow_dispatch:
inputs:
ref:
description: 'Ref (e.g. v0.1.30)'
description: 'Tag/ref to build (e.g. v0.1.30)'
required: true
type: string
repo:
description: 'Override default repo'
required: false
type: string
release:
description: 'Release type'
description: '(optional) Release type to create in https://github.com/docker/packaging/releases'
required: false
default: 'pushonly'
default: 'draft'
type: choice
options:
- pushonly
- draft
- prerelease
- release
distros:
description: 'Distros to build (comma-separated, e.g. "debian12,ubuntu22.04")'
description: '(optional, empty = all supported) Distros to build (comma-separated, e.g. "debian12,ubuntu2204")'
required: false
type: string
default: ''
Expand All @@ -37,6 +33,10 @@ on:
required: false
type: string
default: ''
repo:
description: '(optional) Override default repo (if want to build from a different Github repo/fork)'
required: false
type: string

jobs:
release:
Expand Down