Skip to content

Commit 1be4a54

Browse files
authored
Update README.md
1 parent be0b095 commit 1be4a54

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Print Workflow Dispatch Inputs and Env Vars
22

3-
This GitHub Action prints all input values from a `workflow_dispatch` event to the log. Optionally, it can also print all environment variables. It's a simple and effective tool for debugging or verifying input values and environment settings in your manually triggered workflows.
3+
This GitHub Action prints all input values from a `workflow_dispatch` event to the log. Optionally, it can also print environment variables and add inputs to the GitHub Summary in a collapsible format.
44

55
## Features
66

77
- Prints all `workflow_dispatch` inputs to the log
88
- Optionally prints all environment variables
9+
- Optionally adds inputs to GitHub Summary in a collapsible format
910
- Minimal configuration required
10-
- Doesn't require a GitHub token
1111
- Lightweight and fast
1212

1313
## Usage
@@ -34,34 +34,36 @@ jobs:
3434
runs-on: ubuntu-latest
3535
steps:
3636
- name: Print Workflow Dispatch Inputs and Env Vars
37-
uses: shayki5/print-workflow-dispatch-inputs@v1
37+
uses: your-username/print-workflow-dispatch-inputs@v1
3838
with:
39-
print_env_vars: 'true' # Set 'true' to print environment variables as well (default: false)
39+
print_env_vars: 'true' # Set to 'true' to print environment variables
40+
add_to_summary: 'true' # Set to 'true' to add inputs to GitHub Summary
4041
```
4142
42-
When you manually trigger this workflow and provide values for the inputs, the action will print these input values to the log. If `print_env_vars` is set to 'true', it will also print all environment variables.
43-
4443
## Inputs
4544
4645
| Input | Description | Required | Default |
4746
|-------|-------------|----------|---------|
4847
| `print_env_vars` | Whether to print environment variables | No | 'false' |
48+
| `add_to_summary` | Whether to add inputs to GitHub Summary | No | 'false' |
4949

50-
## How it Works
50+
## Outputs
5151

52-
This action reads the event payload from the `GITHUB_EVENT_PATH` environment variable, which is automatically set by GitHub Actions. It then uses `jq` to extract and print the input values. If `print_env_vars` is set to 'true', it also prints all environment variables using the `env` command.
52+
| Output | Description |
53+
|--------|-------------|
54+
| `output` | The full output of the action |
5355

54-
## Requirements
56+
## GitHub Summary
5557

56-
This action is designed to work with `workflow_dispatch` events. It will not print inputs for other event types, but can still print environment variables if enabled.
58+
When `add_to_summary` is set to 'true', the action will add the workflow dispatch inputs to the GitHub Summary in a collapsible format. This allows you to easily view the inputs without cluttering the summary.
5759

5860
## License
5961

6062
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
6163

6264
## Contributing
6365

64-
Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/shayki5/print-workflow-dispatch-inputs/issues).
66+
Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/your-username/print-workflow-dispatch-inputs/issues).
6567

6668
## Support
6769

0 commit comments

Comments
 (0)