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.

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

[Feature] Allow to run additional commands in the recipe installer #632

Merged
merged 4 commits into from
Jan 6, 2022
Merged

[Feature] Allow to run additional commands in the recipe installer #632

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20acf4d
add runCommand
noxify Dec 17, 2021
af25b2d
Merge branch 'main' into installer-run-command
JuanM04 Dec 17, 2021
9a3e61a
Update app/pages/docs/writing-recipes.mdx
beerose Jan 6, 2022
0e9fd70
Update app/pages/docs/writing-recipes.mdx
beerose Jan 6, 2022
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
20 changes: 20 additions & 0 deletions app/pages/docs/writing-recipes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,26 @@ builder.addTransformFilesStep({
})
```

### Running an external command (#running-an-external-command)
beerose marked this conversation as resolved.
Show resolved Hide resolved

In case you have a recipe which should run an external command like
`blitz prisma generate`, you can use `addRunCommandStep`.

beerose marked this conversation as resolved.
Show resolved Hide resolved
```ts
builder.addRunCommandStep({
stepId: "runCommand",
stepName: "Generate prisma client",
explanation:
"Since we added a new generator to the prisma schema, we have to update the prisma client",
command: "blitz prisma generate",
})
```

<Card type="info">
We have suppressed the command output, so the user will not see the
result of the executed command.
</Card>

### Publishing {#publishing}

That's all you need to build a recipe! At this point, you can commit and
Expand Down