Skip to content

Commit

Permalink
feat: Updated pysparkler/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sweep-ai[bot] authored Jan 10, 2024
1 parent ac2e8b0 commit ae5ee5d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion pysparkler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,11 +208,15 @@ cat /path/to/sql.sql | pysparkler upgrade-sql

### Dry-Run Mode

For both the above upgrade options, to run in dry mode, you can use the `--dry-run` flag. This will not write the
For running PySparkler in dry-run mode in a GitHub Actions workflow, use the `--dry-run` flag. This will not write the
upgraded script but will print a unified diff of the input and output scripts for you to inspect the changes:

```bash
pysparkler upgrade --input-file /path/to/script.py --dry-run

# Run PySparkler in dry-run mode as part of a GitHub Actions workflow
echo 'Running PySparkler in dry-run mode'
pysparkler upgrade --input-file /path/to/script.py --dry-run
```

### Verbose Mode
Expand Down

0 comments on commit ae5ee5d

Please sign in to comment.