Skip to content

docs: add pipeline examples #2230

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.

Sign up for GitHub

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

Merged
FabianKramm merged 1 commit into from
Aug 17, 2022
Merged

docs: add pipeline examples #2230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/pages/configuration/pipelines/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,22 @@ Pipelines allow you to fully customize the execution logic in DevSpace, i.e. the

Pipelines are defined in POSIX shell syntax and a DevSpace pipeline reads as a regular POSIX script. However, DevSpace implements certain special commands that can be used inside the POSIX script to tell DevSpace when to build, deploy or start developing. For a complete function reference, please take a look below.

<br />

Some example pipelines:
<Tabs
defaultValue="configoverride"
defaultValue="executionorder"
values={[
{ label: 'Dynamic Config', value: 'configoverride' },
{ label: 'Execution Order', value: 'executionorder' },
{ label: 'Dynamic Config', value: 'configoverride' },
{ label: 'Rerun Pipeline', value: 'rerun' },
{ label: 'Deploy / Sync / Open', value: 'deploywaitsync', },
{ label: 'Dockerfile Flag', value: 'dockerfile', },
{ label: 'Custom Dockerfile Flag', value: 'dockerfile', },
]
}>
<TabItem value="configoverride">

```yaml
# Simple deployment that deploys an nginx pod
deployments:
test:
helm:
Expand Down Expand Up @@ -115,7 +116,7 @@ pipelines:
# Start two pipelines in parallel
run_pipelines watch-secret default-deploy

watch-secret:
watch-secret: |-
# Rerun the pipeline as soon as the secret.yaml changes
run_watch -p secret.yaml -- kubectl apply -n ${DEVSPACE_NAMESPACE} -f secret.yaml

Expand Down