Skip to content

Update the --force generator docs to back up before using it #59

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
Mark90 merged 1 commit into from
Aug 25, 2026
Merged

Update the --force generator docs to back up before using it #59

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
9 changes: 4 additions & 5 deletions docs/workshops/example-orchestrator/generator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,15 +144,14 @@ python main.py generate workflows -cf templates/l2_p2p.yaml --no-dryrun
As you can see this file needs to be run with the --force flag as it needs to overwrite a number of configuration
files. Furthermore it will populate the files in `workflows/l2_p2p/`. Do that now:

!!! warning
If you modified any of the files that are going to be overwritten, commit them or back them up before forcefully
overwriting them with the generator and reapply the changes afterwards.

```shell
python main.py generate workflows -cf templates/l2_p2p.yaml --no-dryrun --force
```

!!! warning
There is a [bug](https://github.com/workfloworchestrator/orchestrator-core/issues/1757) in `generate workflows`
which makes it overwrite the contents of `workflows/shared.py` instead of
extend it with the missing elements. You can use `git restore` to restore it aftwards.

Take a look around to see which files have been created by now.
Can you explain what each of them are for?

Expand Down
Loading