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
Interpolation of variables #13
Comments
Yes. Is there a solution that would synchronize the documentation with the manifest, so that we would be in compliance in the future? |
That would be possibly only by running some script manually each time, or by running Action what whould parse the yaml to the right markdown part. For example you would put some tag like this below to the README and the Action would insert new content to it each time on push to master.
And it could work for other data from that file too. That might be interesting, in fact, will we do something like that? |
On the other hand, I can see no repository which has mentioned its inputs in README. :/ |
I would not see it as a single tag, but a separate section It's possible that others are waiting for GitHub to properly document this. |
Maybe we should also wait for final version. Not it's in alpha, beta or something. :-) |
@damccorm are you aware any plans in area of GitHub-provided documentation for actions inputs? Can you share them so that we can decide if it's worth working on it? |
Not that I know of, @rachmari would probably know better than I |
@ad-m we plan to write a short guide that will show people writing a workflow how to use inputs and outputs. For example, it would show you how to supply an action in a workflow with its required inputs and retrieve the output from that action. We'll also explain how a someone developing an action can use inputs and set outputs. We already do that a bit in these two guides: We recommend that anytime you create an action that you include the inputs and outputs that the action requires in the README file of the repository. We are working on ensuring that all repositories in the github.com/actions organization also follow those best practices. You can see an example README that declares the required or optional inputs/outputs here. Let me know if you have any more questions. ✨ |
So there is no plan to parse action.yml by GitHub, if I understand correctly. Users have to convert action.yml to README by self, not as part eg. GitHub Marketplace of GitHub Actions. |
That's a great question. I'm not sure if we plan to do that for actions in Github Marketplace. @ethomson do you know the plans for that? |
In my opinion - since |
We're thinking about a change to take the |
If we do this, though, it will be a display of the data in the |
In my opinion, OpenAPI is a good example of documentation that is machine-processable (suitable for visualization) but understood by human. I suggest analyse how this specs provides for the possibility of placing examples (purely for information purposes). As I know If GitHub Marketplace for GitHub Actions will provide a convenient API for information in |
Thank you for the information that GitHub plans to publish in an attractive way information about "input" and "output". In this case, we can stop our work on automatically updating |
In the
https://github.com/ad-m/github-push-action/blob/master/action.yml#L12
and
https://github.com/ad-m/github-push-action/blame/master/README.md#L35
there is interpolation used as
{{ secrets.GITHUB_TOKEN }}
and${GITHUB_REPOSITORY}
.From the docs I think it should be
${{ <expression> }}
. Should we change it to make it right?The text was updated successfully, but these errors were encountered: