http/README.md

100 lines
5 KiB
Markdown
Raw Normal View History

2020-02-24 04:23:15 -05:00
# 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.
2020-02-24 04:23:15 -05:00
### Example
```yaml
2020-02-24 04:23:15 -05:00
jobs:
2021-01-19 18:21:04 -05:00
deployment:
runs-on: ubuntu-latest
steps:
- name: Deploy Stage
2022-03-04 05:22:31 -05:00
uses: fjogeleit/http-request-action@v1
2021-01-19 18:21:04 -05:00
with:
url: 'https://ansible.io/api/v2/job_templates/84/launch/'
method: 'POST'
username: ${{ secrets.AWX_USER }}
password: ${{ secrets.AWX_PASSWORD }}
customHeaders: '{"Content-Type": "application/json"}'
2022-05-24 06:22:08 -04:00
data: '{"key_1": "value_1", "key_2": "value_2"}'
2020-02-24 04:23:15 -05:00
```
2022-03-04 05:26:59 -05:00
### Versioning
`master` branch is deprecated. Please use `main` or `v1` to get the latest version of this action. It is recommended to use a fixed version.
### Request Configuration
2020-02-24 04:23:15 -05:00
|Argument| Description | Default |
|--------|---------------|-----------|
|url | Request URL | _required_ Field |
|method | Request Method| POST |
|contentType | Request ContentType| application/json |
|data | Request Body Content:<br>- text content like JSON or XML<br>- key=value pairs separated by '&' or JSON data and contentType: application/x-www-form-urlencoded<br><br>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** | '{}' |
2022-02-09 22:14:07 -05:00
|file | Single absolute file path send as `application/octet-stream` request to the API, if set the contentType is set to `application/octet-stream`. This input will be ignored if either `data` or `files` input is present. **Example provided in the _test_ Workflow of this Action** ||
2020-02-24 04:23:15 -05:00
|timeout| Request Timeout in ms | 5000 (5s) |
|username| Username for Basic Auth ||
|password| Password for Basic Auth ||
|bearerToken| Bearer Authentication Token (without Bearer Prefix) ||
2020-03-25 06:15:19 -04:00
|customHeaders| Additional header values as JSON string, keys in this object overwrite default headers like Content-Type |'{}'|
|escapeData| Escape newlines in data string content. 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 ||
|ignoreStatusCodes| Prevent this Action to fail if the request respond with one of the configured Status Codes. Example: '404,401' ||
|httpsCA| Certificate authority as string in PEM format ||
|responseFile| Persist the response data to the specified file path ||
|retry| optional amount of retries if the request is failing, does not retry if the status code is ignored ||
|retryWait| time between each retry in millseconds | 3000 |
2020-02-24 04:23:15 -05:00
### Response
2020-02-24 04:23:15 -05:00
| Variable | Description |
|---|---|
`response` | Response as JSON String
`headers` | Headers
2020-04-21 08:16:49 -04:00
2022-05-24 06:22:08 -04:00
To display HTTP response data in the GitHub Actions log give the request an `id` and access its `outputs`. You can also access specific field from the response data using [fromJson()](https://docs.github.com/en/actions/learn-github-actions/expressions#fromjson) expression.
2020-04-21 08:16:49 -04:00
```yaml
steps:
- name: Make Request
id: myRequest
2022-03-04 05:22:31 -05:00
uses: fjogeleit/http-request-action@v1
with:
url: "http://yoursite.com/api"
- name: Show Response
2022-05-24 06:22:08 -04:00
run: |
echo ${{ steps.myRequest.outputs.response }}
echo ${{ steps.myRequest.outputs.headers }}
2022-05-24 06:22:08 -04:00
echo ${{ fromJson(steps.myRequest.outputs.response).field_you_want_to_access }}
```
2020-04-21 08:16:49 -04:00
### Additional Information
2020-04-21 08:16:49 -04:00
Additional information is available if debug logging is enabled:
2020-04-21 08:16:49 -04:00
- Instance Configuration (Url / Timeout / Headers)
2020-06-30 04:30:02 -04:00
- 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`
#### Local Usage
* You can execute this tool locally with the provided CLI `bin/http-action`.
```bash
bin/http-action --help
Positionals:
url request URL [string]
Optionen:
--help helper text [boolean]
-d, --data request body data [string] [default: "{}"]
-f, --files request files, send as multipart/form-data [string] [default: "{}"]
--file single file, send as application/octet-stream [string]
-h, --customHeaders custom request headers [string] [default: "{}"]
-m, --method request method (GET, POST, PATCH, PUT, DELETE) [string] [default: "POST"]
-t, --contentType request content type [string] [default: "application/json"]
--bearerToken bearer token without Bearer prefix, added as
Authorization header [string]
--timeout request timeout [number] [default: 5000]
```