Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 1.9 KB

README.md

File metadata and controls

61 lines (47 loc) · 1.9 KB

This README is edited from this project

Credit to them for giving me a blueprint to work with.

HTTP Request Action

Create HTTP Requests from GitHub Actions. This action allows GitHub events to engage with public websites.

Example

jobs:
  deployment:
    runs-on: ubuntu-latest
    steps:
    - name: Deploy Stage
      uses: nxg-org/github-http2-action@master
      with:
        url: 'https://nghttp2.org/httpbin/anything'
        method: 'POST'
        data: '{"foo": "bar"}'

Request Configuration

Argument Description Default
url Request URL required
method Request Method POST
contentType Request ContentType application/json
data Request Body Content as JSON String, only for POST / PUT / PATCH Requests undefined
body Raw body content of request (overrides data, I.E. image byte contents) undefined
headers Additional header values as JSON string, keys in this object overwrite default headers like Content-Type undefined

Response

Variable Description
body Response as JSON String
headers Response headers

To display HTTP response data in the GitHub Actions log give the request an id and access its outputs

steps:
  - name: Make Request
    id: myRequest
    uses: nxg-org/github-http2-action@master
    with:
      url: "http://yoursite.com/api"
  - name: Show Response
    run: echo ${{ steps.myRequest.outputs.body }}

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 create a secret ACTIONS_RUNNER_DEBUG with a value of true