Compare commits

...

3 Commits

Author SHA1 Message Date
Frank Jogeleit
7626a13e42 Disable MaxContentLength and MaxBodyLength check (#23)
* Disable MaxContentLength and MaxBodyLength check
2021-02-19 11:36:10 +01:00
Scott W Harden
48dc3972df 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.
2021-01-26 17:49:24 +01:00
Frank Jogeleit
84e61f1a56 Update version 2021-01-24 14:09:17 +01:00
4 changed files with 41 additions and 24 deletions

View File

@@ -1,9 +1,9 @@
# 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:
deployment:
runs-on: ubuntu-latest
@@ -17,7 +17,7 @@ jobs:
password: ${{ secrets.AWX_PASSWORD }}
```
### Input Arguments
### Request Configuration
|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 ||
|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)
- 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`

22
package-lock.json generated
View File

@@ -1,6 +1,6 @@
{
"name": "http-request-action",
"version": "1.7.0",
"version": "1.7.2",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
@@ -47,9 +47,9 @@
"integrity": "sha512-SSG5xmZh1mkPGyKzjZP8zLjltIfpW32Y5QpdNJyjcfGxK3qo3NDDkZOZSFiGn1A6SclQxY9GzEwAHQ3dmYRWpg=="
},
"form-data": {
"version": "3.0.0",
"resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.0.tgz",
"integrity": "sha512-CKMFDglpbMi6PyN+brwB9Q/GOw0eAnsrEZDgcsH5Krhz5Od/haKHAX0NmQfha2zPPz0JpWzA7GJHGSnvCRLWsg==",
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/form-data/-/form-data-3.0.1.tgz",
"integrity": "sha512-RHkBKtLWUVwd7SqRIvCZMEvAMoGUp0XU+seQiZejj0COz3RI3hWP4sCv3gZWWLjJTd7rGwcsF5eKZGii0r/hbg==",
"requires": {
"asynckit": "^0.4.0",
"combined-stream": "^1.0.8",
@@ -57,16 +57,16 @@
}
},
"mime-db": {
"version": "1.45.0",
"resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.45.0.tgz",
"integrity": "sha512-CkqLUxUk15hofLoLyljJSrukZi8mAtgd+yE5uO4tqRZsdsAJKv0O+rFMhVDRJgozy+yG6md5KwuXhD4ocIoP+w=="
"version": "1.46.0",
"resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.46.0.tgz",
"integrity": "sha512-svXaP8UQRZ5K7or+ZmfNhg2xX3yKDMUzqadsSqi4NCH/KomcH75MAMYAGVlvXn4+b/xOPhS3I2uHKRUzvjY7BQ=="
},
"mime-types": {
"version": "2.1.28",
"resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.28.tgz",
"integrity": "sha512-0TO2yJ5YHYr7M2zzT7gDU1tbwHxEUWBCLt0lscSNpcdAfFyJOVEpRYNS7EXVcTLNj/25QO8gulHC5JtTzSE2UQ==",
"version": "2.1.29",
"resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.29.tgz",
"integrity": "sha512-Y/jMt/S5sR9OaqteJtslsFZKWOIIqMACsJSiHghlCAyhf7jfVYjKBmLiX8OgpWeW+fjJ2b+Az69aPFPkUOY6xQ==",
"requires": {
"mime-db": "1.45.0"
"mime-db": "1.46.0"
}
}
}

View File

@@ -1,6 +1,6 @@
{
"name": "http-request-action",
"version": "1.7.0",
"version": "1.7.2",
"description": "",
"main": "src/index.js",
"private": false,
@@ -13,7 +13,7 @@
},
"keywords": [],
"author": "",
"license": "ISC",
"license": "MIT",
"bugs": {
"url": "https://github.com/fjogeleit/http-request-action/issues"
},
@@ -24,6 +24,6 @@
"dependencies": {
"@zeit/ncc": "^0.22",
"axios": "^0.21.1",
"form-data": "^3.0.0"
"form-data": "^3.0.1"
}
}

View File

@@ -9,7 +9,7 @@ const request = async({ method, instanceConfig, data, files, auth, actions, prev
try {
if (escapeData) {
data = data.replace(/"[^"]*"/g, (match) => {
return match.replace(/[\n\r]\s*/g, "\\n");
return match.replace(/[\n\r]\s*/g, "\\n");
});
}
@@ -35,7 +35,9 @@ const request = async({ method, instanceConfig, data, files, auth, actions, prev
const requestData = {
auth,
method,
data
data,
maxContentLength: Infinity,
maxBodyLength: Infinity
}
actions.debug('Instance Configuration: ' + JSON.stringify(instanceConfig))