Skip to content
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.

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

Add action API typing #282

Open
krzema12 opened this issue Nov 25, 2022 · 1 comment
Open

Add action API typing #282

krzema12 opened this issue Nov 25, 2022 · 1 comment

Comments

@krzema12
Copy link

Hi!

Would you be open for introducing typing for your action's API (inputs and outputs) using https://github.com/krzema12/github-actions-typing/? To see how such typing could look like, see https://github.com/krzema12/github-workflows-kt/blob/main/actions/softprops/action-gh-release/v1/action-types.yml.

Some context: I maintain https://github.com/krzema12/github-workflows-kt, it's a library for describing GitHub Actions workflows in a type-safe way, in Kotlin. Since actions themselves don't contain information about types of their input and output, we need to keep the typings in our repository to generate type-safe Kotlin code. To better scale across the number of actions, I came up with the idea of https://github.com/krzema12/github-actions-typing/ which can be adopted by library authors and the authors themselves can decide about proper typing, and thanks to this we don't have to maintain the typings ourselves. The typings are language-agnostic, I can imagine someone creating a similar library with TypeScript code generation.

Feel free to ask any questions. I'm also keen to open a PR.

Best,
Piotr

@krzema12
Copy link
Author

krzema12 commented Feb 1, 2023

@softprops do you need any explanation on this? Happy to answer questions and accept feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant