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 means to define the process of an output #1051

Closed
cdavernas opened this issue Jan 8, 2025 · 0 comments
Closed

Add means to define the process of an output #1051

cdavernas opened this issue Jan 8, 2025 · 0 comments
Assignees
Labels
area: spec Changes in the Specification change: documentation Improvements or additions to documentation. It won't impact a version change. change: feature New feature or request. Impacts in a minor version change type: feature
Milestone

Comments

@cdavernas
Copy link
Member

What would you like to be added?

As suggested by @matthias-pichler here, we should add a new property to process definitions, used to configure the output.

Proposal(s):

Run

Properties

Name Type Required Description
run.container container no The definition of the container to run.
Required if script, shell and workflow have not been set.
run.script script no The definition of the script to run.
Required if container, shell and workflow have not been set.
run.shell shell no The definition of the shell command to run.
Required if container, script and workflow have not been set.
run.workflow workflow no The definition of the workflow to run.
Required if container, script and shell have not been set.
await boolean no Determines whether or not the process to run should be awaited for.
Defaults to true.
return string no Configures the output of the process.
Supported values are:
- stdout: Outputs the content of the process STDOUT.
- stderr: Outputs the content of the process STDERR.
- code: Outputs the process's exit code.
- all: Outputs the exit code, the STDOUT content and the STDERR content, wrapped into a new processResult object.
- none: Does not output anything.
Defaults to stdout.

Process Result

Properties

Name Type Required Description
code integer yes The process's exit code.
stdout string yes The process's STDOUT output.
stderr string yes The process's STDERR output.

Alternative(s):

No response

Additional info:

No response

Community Notes

  • Please vote by adding a 👍 reaction to the feature to help us prioritize.
  • If you are interested to work on this feature, please leave a comment.
@cdavernas cdavernas added change: documentation Improvements or additions to documentation. It won't impact a version change. change: feature New feature or request. Impacts in a minor version change area: spec Changes in the Specification type: feature labels Jan 8, 2025
@cdavernas cdavernas added this to the v1.0.0 milestone Jan 8, 2025
@cdavernas cdavernas self-assigned this Jan 8, 2025
@github-project-automation github-project-automation bot moved this from Backlog to Done in Progress Tracker Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: spec Changes in the Specification change: documentation Improvements or additions to documentation. It won't impact a version change. change: feature New feature or request. Impacts in a minor version change type: feature
Projects
Status: Done
Development

No branches or pull requests

1 participant