Skip to content

Update README with migration guide for deprecated action - #304

Open
f18m wants to merge 5 commits into
home-assistant:masterfrom
f18m:patch-1
Open

Update README with migration guide for deprecated action#304
f18m wants to merge 5 commits into
home-assistant:masterfrom
f18m:patch-1

Conversation

@f18m

@f18m f18m commented Apr 23, 2026

Copy link
Copy Markdown

Added migration guide for deprecated home-assistant/builder action.

Added migration guide for deprecated home-assistant/builder action.

@home-assistant home-assistant Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hi @f18m

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant
home-assistant Bot marked this pull request as draft April 23, 2026 21:14
@home-assistant

Copy link
Copy Markdown

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Added note about workflow supporting push targets.
@f18m
f18m marked this pull request as ready for review April 23, 2026 21:33

@eshattow eshattow left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@eshattow eshattow left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I suggest appending to the existing note with simple additional sentence "This workflow works similarly for push targets e.g. to build and publish an image on every git push." It is strange looking to me to see several footnotes ahead of the topic of discussion.

@sairon sairon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think the note is slightly misleading, ideally for push it will need some extra handling. Maybe just default to Git commit SHA if the release version is undefined? Ideally I'd like to see a PoC it works then.

Comment thread README.md Outdated
Comment thread README.md Outdated

The following example workflow builds multi-arch container images when a GitHub release is published. It prepares a build matrix, builds per-architecture images in parallel (e.g., `ghcr.io/owner/amd64-my-image`, `ghcr.io/owner/aarch64-my-image`), and then combines them into a single multi-arch manifest (`ghcr.io/owner/my-image`).

Note that the workflow below works also for `push` targets in case you want to build and publish an image on every git push.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Well, not really, it will need few more changes, especially because ${{ github.event.release.tag_name }} won't be defined. While it will probably not fail, the behavior might not be what the developer expects (as version will be completely empty and images will be tagged only with the latest tag).

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

yes I tried using that workflow with the on: push trigger and I confirm that the ${{ github.event.release.tag_name }} will be empty and the image will be labelled only with the latest tag.I added a note about that...

@home-assistant
home-assistant Bot marked this pull request as draft April 24, 2026 07:54
@f18m
f18m marked this pull request as ready for review May 5, 2026 09:03
@home-assistant
home-assistant Bot requested review from eshattow and sairon May 5, 2026 09:03
@sairon sairon linked an issue May 6, 2026 that may be closed by this pull request
@sairon sairon changed the title Fix #301: Update README with migration guide for deprecated action Update README with migration guide for deprecated action May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing docs for migration to new builder action

3 participants