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

[Feature request] Add action typings #52

Closed
krzema12 opened this issue Jul 18, 2022 · 2 comments
Closed

[Feature request] Add action typings #52

krzema12 opened this issue Jul 18, 2022 · 2 comments

Comments

@krzema12
Copy link

Hi @Borales!

Maintainer of https://github.com/krzema12/github-actions-kotlin-dsl here. Your action has first-class support in the library.

Recently we've come up with a way to reduce operational load when keeping library's action wrappers in sync with action's inputs. The solution includes onboarding https://github.com/krzema12/github-actions-typing. It's as easy as adding an extra YAML file to your repository root, and adding a simple GitHub workflow that validates this new file. Thanks to this, the code generator in the Kotlin DSL can fetch typing info provided by you instead of us, which has a number of benefits. It has no negative effects on current action consumers, they continue to use the action via regular GitHub API, as if the file wasn't there. The typings themselves are unaware of the Kotlin DSL, and any other tool (let it be another code generator or documentation tool) can use the typings if you provide them.

In this feature request, I would like to ask you if you're open to introducing such typings in your action. You wouldn't be first - there're already other actions using it: https://github.com/krzema12/github-actions-typing/network/dependents

If your answer is "yes", feel free to either add it yourself, or let me know - me or some of my fellow contributors would be happy to post PRs. We're also open to any kind of questions and feedback.

@Borales
Copy link
Owner

Borales commented Nov 27, 2022

Hi @krzema12
Thank you for the suggestion, but I don't see a real benefit of this change.
Storing action.yml/inputs plus in-code validation is more than enough.

Thank you for your suggestion though :)

@Borales Borales closed this as completed Nov 27, 2022
@krzema12
Copy link
Author

Yeah, for you the benefit is little, but for some of the users of your action, it would really make sense.

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

2 participants