mirror of
https://github.com/fjogeleit/http-request-action.git
synced 2024-11-25 13:20:56 -05:00
more documentation with code sample (#21)
* improve debug logging documentation * document how to log response content * add syntax highlighting * improve description This action can be used to do more than just interact with Ansible AWS. I rephrased the description to emphasize its general utility.
This commit is contained in:
parent
84e61f1a56
commit
48dc3972df
1 changed files with 23 additions and 8 deletions
31
README.md
31
README.md
|
@ -1,9 +1,9 @@
|
||||||
# HTTP Request Action
|
# HTTP Request Action
|
||||||
|
|
||||||
Create any kind of HTTP Requests in your GitHub actions to trigger Tools like Ansible AWX
|
**Create HTTP Requests from GitHub Actions.** This action allows GitHub events to engage with tools like Ansible AWX that use HTTP APIs.
|
||||||
|
|
||||||
Example Usage:
|
### Example
|
||||||
```
|
```yaml
|
||||||
jobs:
|
jobs:
|
||||||
deployment:
|
deployment:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
@ -17,7 +17,7 @@ jobs:
|
||||||
password: ${{ secrets.AWX_PASSWORD }}
|
password: ${{ secrets.AWX_PASSWORD }}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Input Arguments
|
### Request Configuration
|
||||||
|
|
||||||
|Argument| Description | Default |
|
|Argument| Description | Default |
|
||||||
|--------|---------------|-----------|
|
|--------|---------------|-----------|
|
||||||
|
@ -34,14 +34,29 @@ jobs:
|
||||||
|preventFailureOnNoResponse| Prevent this Action to fail if the request respond without an response. Use 'true' (string) as value to enable it ||
|
|preventFailureOnNoResponse| Prevent this Action to fail if the request respond without an response. Use 'true' (string) as value to enable it ||
|
||||||
|escapeData| Escape newlines in data string content. Use 'true' (string) as value to enable it ||
|
|escapeData| Escape newlines in data string content. Use 'true' (string) as value to enable it ||
|
||||||
|
|
||||||
### Output
|
### Response
|
||||||
|
|
||||||
- `response` Request Response as JSON String
|
| Variable | Description |
|
||||||
|
|---|---|
|
||||||
|
`response` | Response as JSON String
|
||||||
|
|
||||||
|
To display HTTP response data in the GitHub Actions log give the request an `id` and access its `outputs`
|
||||||
|
|
||||||
### Debug Informations
|
```yaml
|
||||||
|
steps:
|
||||||
|
- name: Make Request
|
||||||
|
id: myRequest
|
||||||
|
uses: fjogeleit/http-request-action@master
|
||||||
|
with:
|
||||||
|
url: "http://yoursite.com/api"
|
||||||
|
- name: Show Response
|
||||||
|
run: echo ${{ steps.myRequest.outputs.response }}
|
||||||
|
```
|
||||||
|
|
||||||
Enable Debug mode to get informations about
|
### Additional Information
|
||||||
|
|
||||||
|
Additional information is available if debug logging is enabled:
|
||||||
- Instance Configuration (Url / Timeout / Headers)
|
- Instance Configuration (Url / Timeout / Headers)
|
||||||
- Request Data (Body / Auth / Method)
|
- Request Data (Body / Auth / Method)
|
||||||
|
|
||||||
|
To [enable debug logging in GitHub Actions](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging) create a secret `ACTIONS_RUNNER_DEBUG` with a value of `true`
|
Loading…
Reference in a new issue