Skip to content

Latest commit

 

History

History
128 lines (113 loc) · 20.2 KB

supported-workflow-features.mdx

File metadata and controls

128 lines (113 loc) · 20.2 KB

Supported GitHub Workflow features

Note

The table below is an hand-made list of all features that PipelineUI should support according to the GitHub workflow syntax schema.

If you encounter any problem, please fill an issue on GitHub.

Generic workflow detail

Feature Supported
name
run-name
on
on.<event_name>.types
on.<pull_request|pull_request_target>.<branches|branches-ignore>
on.push.<branches|tags|branches-ignore|tags-ignore>
on.<push|pull_request|pull_request_target>.<paths|paths-ignore>
on.<push|pull_request|pull_request_target>.<paths|paths-ignore>
on.schedule
on.workflow_call
on.workflow_call.inputs
on.workflow_call.inputs.<input_id>.type
on.workflow_call.outputs
on.workflow_call.secrets
on.workflow_call.secrets.<secret_id>
on.workflow_call.secrets.<secret_id>.required
on.workflow_run.<branches|branches-ignore>
on.workflow_dispatch
on.workflow_dispatch.inputs
on.workflow_dispatch.inputs.<input_id>.required
on.workflow_dispatch.inputs.<input_id>.required
on.workflow_dispatch.inputs.<input_id>.type
permissions
env
defaults
defaults.run
defaults.run.shell
defaults.run.working-directory
concurrency

Jobs

Feature Supported
jobs
jobs.<job_id>
jobs.<job_id>.name
jobs.<job_id>.permissions
jobs.<job_id>.needs
jobs.<job_id>.if
jobs.<job_id>.runs-on
jobs.<job_id>.environment
jobs.<job_id>.concurrency
jobs.<job_id>.outputs
jobs.<job_id>.env
jobs.<job_id>.defaults
jobs.<job_id>.defaults.run
jobs.<job_id>.defaults.run.shell
jobs.<job_id>.defaults.run.working-directory
jobs.<job_id>.timeout-minutes
jobs.<job_id>.uses
jobs.<job_id>.with
jobs.<job_id>.with.<input_id>

Jobs Step

Feature Supported
jobs.<job_id>.steps
jobs.<job_id>.steps[*].id
jobs.<job_id>.steps[*].if
jobs.<job_id>.steps[*].name
jobs.<job_id>.steps[*].uses
jobs.<job_id>.steps[*].run
jobs.<job_id>.steps[*].working-directory
jobs.<job_id>.steps[*].shell
jobs.<job_id>.steps[*].with
jobs.<job_id>.steps[*].with.args
jobs.<job_id>.steps[*].with.entrypoint
jobs.<job_id>.steps[*].env
jobs.<job_id>.steps[*].continue-on-error
jobs.<job_id>.steps[*].timeout-minutes

Job container

Feature Supported
jobs.<job_id>.container
jobs.<job_id>.container.image
jobs.<job_id>.container.credentials
jobs.<job_id>.container.env
jobs.<job_id>.container.ports
jobs.<job_id>.container.volumes
jobs.<job_id>.container.options

Job strategy

Feature Supported
jobs.<job_id>.strategy
jobs.<job_id>.strategy.matrix
jobs.<job_id>.strategy.matrix.include
jobs.<job_id>.strategy.matrix.exclude
jobs.<job_id>.strategy.fail-fast
jobs.<job_id>.strategy.max-parallel
jobs.<job_id>.strategy.continue-on-error

Job services

Feature Supported
jobs.<job_id>.services
jobs.<job_id>.services.<service_id>.image
jobs.<job_id>.services.<service_id>.credentials
jobs.<job_id>.services.<service_id>.env
jobs.<job_id>.services.<service_id>.ports
jobs.<job_id>.services.<service_id>.volumes
jobs.<job_id>.services.<service_id>.options

Job secrets

Feature Supported
jobs.<job_id>.secrets
jobs.<job_id>.secrets.inherit
jobs.<job_id>.secrets.<secret_id>