Skip to content

Comments

Add action typings with validation#721

Merged
eifinger merged 2 commits intoastral-sh:mainfrom
krzema12:add-typings
Dec 19, 2025
Merged

Add action typings with validation#721
eifinger merged 2 commits intoastral-sh:mainfrom
krzema12:add-typings

Conversation

@krzema12
Copy link
Contributor

@krzema12 krzema12 commented Dec 18, 2025

I'd like to add machine-readable type hints for this action. They also serve as a formal documentation on the types of action's inputs and outputs, which is a standardized way of documenting these also for human users. See https://github.com/typesafegithub/github-actions-typing for details. Dozens of actions already provide typings this way.

In particular, this change will let the users of https://github.com/typesafegithub/github-workflows-kt use this action in a convenient, type-safe way from their Kotlin workflows. From the binding service's metrics I see that this action is among the most popular ones that doesn't have typings configured, so on behalf of the users of this tool, I'm asking you to consider adding the typings.

@krzema12 krzema12 requested a review from eifinger as a code owner December 18, 2025 08:13
@krzema12 krzema12 changed the title Add aciton typings with validation Add action typings with validation Dec 18, 2025
Copy link
Collaborator

@eifinger eifinger left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution.

While this is an additional feature we have to maintain, I think the added benefit outweighs the maintenance overhead.

@eifinger eifinger added the enhancement New feature or request label Dec 19, 2025
@eifinger eifinger merged commit 45cfcb3 into astral-sh:main Dec 19, 2025
374 of 383 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants