Skip to content

Add landingpage type to the version helper #140

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
sairon merged 1 commit into from
Jun 11, 2026
Merged

Add landingpage type to the version helper #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 25 additions & 4 deletions helpers/version/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Determines **version**, **stability**, **channel**, and **publish** status for H

| Input | Required | Default | Description |
|--------|----------|-----------|----------------------------------------------------------|
| `type` | no | `generic` | Target type: `core`, `supervisor`, `plugin`, or `generic` |
| `type` | no | `generic` | Target type: `core`, `supervisor`, `plugin`, `generic`, or `landingpage` |

## Outputs

Expand Down Expand Up @@ -52,6 +52,27 @@ These two types produce identical outputs.

---

## Build Type: `landingpage`

Used for the landingpage image, which is pushed as a tag on the existing
`*-homeassistant` images. Version and channel resolve exactly like
`plugin`/`supervisor`, but - like `core` - it is **only published on a release
tag**, never on a push/merge to the default branch.

| Trigger | version | stable | channel | publish |
|----------------------|----------------------------------|---------|---------|---------|
| **Pull Request** | `<commit SHA>` | `false` | `dev` | `false` |
| **Push to master** | CalVer dev `YYYY.MM.X.devDDNN` | `false` | `dev` | `false` |
| **Release (tag)** | Tag name (e.g. `2024.12.1`) | `true` | `beta` | `true` |
| **Push to tag** | Tag name | `false` | `dev` | `false` |
| **workflow_dispatch** | From inputs or ref | From inputs or `false` | From inputs or computed | From inputs or `false` |

### Notes
- **Only releases are published.** Pushes (including merges to the default branch), PRs, and other events all produce `publish=false`.
- The image is always pushed under the `landingpage` tag; the resolved `version` is only used as the image version label.

---

## Build Type: `core`

| Trigger | version | stable | channel | publish |
Expand Down Expand Up @@ -97,9 +118,9 @@ These two types produce identical outputs.
github.event.inputs.version set?
├─ YES → use that value
└─ NO
├─ ref is master/main AND type is supervisor/plugin/generic?
├─ ref is master/main AND type is supervisor/plugin/generic/landingpage?
│ └─ YES → CalVer dev: YYYY.MM.X.devDDNN
├─ ref is "merge" AND type is supervisor/plugin/generic?
├─ ref is "merge" AND type is supervisor/plugin/generic/landingpage?
│ └─ YES → commit SHA
├─ ref is "dev" AND type is core?
│ └─ YES → nightly bump via version_bump.py
Expand All @@ -108,7 +129,7 @@ github.event.inputs.version set?

## CalVer Dev Version Format

Used by `supervisor`, `plugin`, and `generic` on pushes to master/main:
Used by `supervisor`, `plugin`, `generic`, and `landingpage` on pushes to master/main:

```
YYYY.MM.N.devDDNN
Expand Down
12 changes: 7 additions & 5 deletions helpers/version/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: 'Home Assistant helper: version'
description: 'GitHub action helper: version'
inputs:
type:
description: The type of target to check against (core, supervisor, plugin, generic)
description: The type of target to check against (core, supervisor, plugin, generic, landingpage)
required: false
default: 'generic'
outputs:
Expand Down Expand Up @@ -50,7 +50,7 @@ runs:
if [[ ! -z "$GITHUB_EVENT_INPUTS_VERSION" ]]; then
version="$GITHUB_EVENT_INPUTS_VERSION"

elif [[ "${version}" =~ (master|main) && "$INPUTS_TYPE" =~ (supervisor|plugin|generic) ]]; then
elif [[ "${version}" =~ (master|main) && "$INPUTS_TYPE" =~ (supervisor|plugin|generic|landingpage) ]]; then
today="$(date --utc '+%Y-%m-%d')"
midnight_timestamp="$(date --utc +%s --date=$today)"
calver_date="$(date --utc --date=$today '+%Y.%m')"
Expand All @@ -64,7 +64,7 @@ runs:
calver_dev="$(date --utc --date=$today '+.dev%d')$(printf "%02d" ${commit_count})"
version="${base_ver}${calver_dev}"

elif [[ "${version}" == "merge" && "$INPUTS_TYPE" =~ (supervisor|plugin|generic) ]]; then
elif [[ "${version}" == "merge" && "$INPUTS_TYPE" =~ (supervisor|plugin|generic|landingpage) ]]; then
version="${{ github.sha }}"

elif [[ "${version}" == "dev" && "$INPUTS_TYPE" == "core" ]]; then
Expand Down Expand Up @@ -95,7 +95,7 @@ runs:
if [[ ! -z "$GITHUB_EVENT_INPUTS_CHANNEL" ]]; then
echo "channel=$GITHUB_EVENT_INPUTS_CHANNEL" >> "$GITHUB_OUTPUT"

elif [[ "$INPUTS_TYPE" =~ (plugin|supervisor) ]]; then
elif [[ "$INPUTS_TYPE" =~ (plugin|supervisor|landingpage) ]]; then
if [[ "${{ steps.version.outputs.stable }}" == "true" ]]; then
echo "channel=beta" >> "$GITHUB_OUTPUT"
else
Expand Down Expand Up @@ -132,7 +132,9 @@ runs:
echo "publish=false" >> "$GITHUB_OUTPUT"
fi

elif [[ "$INPUTS_TYPE" == "core" ]]; then
# landingpage resolves version/channel like supervisor/plugin, but is only
# ever published from a release tag - never on push/merge to the default branch.
elif [[ "$INPUTS_TYPE" =~ (core|landingpage) ]]; then
if [[ "$EVENT_NAME" == "release" ]]; then
echo "publish=true" >> "$GITHUB_OUTPUT"
else
Expand Down
Loading