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

Missing documentation for the "json" communication mode of the Actions plugin #2083

Open
jrohel opened this issue Feb 24, 2025 · 0 comments
Open
Assignees
Labels
Priority: LOW RFE Request For Enhancement (as opposed to a bug) Triaged Someone on the DNF 5 team has read the issue and determined the next steps to take

Comments

@jrohel
Copy link
Contributor

jrohel commented Feb 24, 2025

The Actions plugin supports two modes of communication between the process being executed and the plugin:

  • "mode=plain" - The original and default communication model.
    Data is only passed to the process via arguments when it is started. The process can send data to the actions plugin by writing to the standard output.

  • "mode=json" - Communication mode introduced in version 1.2.0 of the actions plugin.
    This mode adds bidirectional communication between the actions plugin and the process. This is a request/response type of communication. The process sends requests and the actions plugin sends responses. The process writes requests to the standard output and reads responses from the standard input. The communication uses JSON format.

The "json" communication mode offers more functionality, but is not documented.

@jrohel jrohel self-assigned this Feb 24, 2025
@ppisar ppisar added RFE Request For Enhancement (as opposed to a bug) Priority: LOW Triaged Someone on the DNF 5 team has read the issue and determined the next steps to take labels Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: LOW RFE Request For Enhancement (as opposed to a bug) Triaged Someone on the DNF 5 team has read the issue and determined the next steps to take
Projects
None yet
Development

No branches or pull requests

2 participants