mirror of
https://github.com/fjogeleit/http-request-action.git
synced 2024-12-23 04:37:28 +00:00
48dc3972df
* 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.
62 lines
No EOL
2.5 KiB
Markdown
62 lines
No EOL
2.5 KiB
Markdown
# HTTP Request Action
|
|
|
|
**Create HTTP Requests from GitHub Actions.** This action allows GitHub events to engage with tools like Ansible AWX that use HTTP APIs.
|
|
|
|
### Example
|
|
```yaml
|
|
jobs:
|
|
deployment:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Deploy Stage
|
|
uses: fjogeleit/http-request-action@master
|
|
with:
|
|
url: 'https://ansible.io/api/v2/job_templates/84/launch/'
|
|
method: 'POST'
|
|
username: ${{ secrets.AWX_USER }}
|
|
password: ${{ secrets.AWX_PASSWORD }}
|
|
```
|
|
|
|
### Request Configuration
|
|
|
|
|Argument| Description | Default |
|
|
|--------|---------------|-----------|
|
|
|url | Request URL | _required_ Field |
|
|
|method | Request Method| POST |
|
|
|contentType | Request ContentType| application/json |
|
|
|data | Request Body Content as JSON String, only for POST / PUT / PATCH Requests | '{}' |
|
|
|files | Map of key / absolute file paths send as multipart/form-data request to the API, if set the contentType is set to multipart/form-data, values provided by data will be added as additional FormData values, nested objects are not supported. **Example provided in the _test_ Workflow of this Action** | '{}' |
|
|
|timeout| Request Timeout in ms | 5000 (5s) |
|
|
|username| Username for Basic Auth ||
|
|
|password| Password for Basic Auth ||
|
|
|bearerToken| Bearer Authentication Token (without Bearer Prefix) ||
|
|
|customHeaders| Additional header values as JSON string, keys in this object overwrite default headers like Content-Type |'{}'|
|
|
|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 ||
|
|
|
|
### Response
|
|
|
|
| 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`
|
|
|
|
```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 }}
|
|
```
|
|
|
|
### Additional Information
|
|
|
|
Additional information is available if debug logging is enabled:
|
|
- Instance Configuration (Url / Timeout / Headers)
|
|
- 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` |