Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
magodo committed Jan 22, 2025
1 parent d3054e4 commit 3ddc4c2
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ Start Timestamp,End Timestamp,Stage,Action,Module,Resource Type,Resource Name,Re

## FAQ

### How to use in CI?

By default, `pipeform` requires a [`tty`](https://man7.org/linux/man-pages/man7/pty.7.html) to make the UI work, which is unavailable in most CI systems (e.g. Github Action [has no tty](https://github.com/actions/runner/issues/241)). To support this environment, the tool comes with an option `--plain-ui`, which will print out logs similar to the `terraform` default logs, except for the operations, it will prefix with a progress indicator.

[Example](https://github.com/magodo/pipeform/actions/runs/12745773365/job/35520444647).

### How to copy output variables?

In a successful run, the tool will end up at the `SUMMARY` stage, that displays a table of output variables defined. Users can select any of the output variables and press <kbd>c</kbd> to copy the value to the system clipboard.
Expand Down

0 comments on commit 3ddc4c2

Please sign in to comment.