https://github.com/madhead/intellij-http-client-action

A thin GitHub Action wrapper around the IntelliJ HTTP Client CLI.
https://github.com/madhead/intellij-http-client-action

actions cli github-action github-actions http http-client httpclient intellij

Last synced: 3 months ago
JSON representation

A thin GitHub Action wrapper around the IntelliJ HTTP Client CLI.

• Host: GitHub
• URL: https://github.com/madhead/intellij-http-client-action
• Owner: madhead
• License: mit
• Created: 2022-12-21T20:31:33.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-26T15:21:23.000Z (3 months ago)
• Last Synced: 2024-09-27T05:22:30.565Z (3 months ago)
• Topics: actions, cli, github-action, github-actions, http, http-client, httpclient, intellij
• Language: Shell
• Homepage:
• Size: 28.3 KB
• Stars: 27
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.adoc
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
= IntelliJ HTTP Client CLI GitHub Action

This is a thin GitHub Action wrapper around the https://blog.jetbrains.com/idea/2022/12/http-client-cli-run-requests-and-tests-on-ci[IntelliJ HTTP Client CLI].

It allows you to run `*.http` files in your GitHub Actions workflows.

== Usage

The action accepts the same inputs as the original CLI tool.

Refer to it's documentation for more details.

A simple way to get that documentation is to run the tool with Docker: `docker run --rm -it jetbrains/intellij-http-client:latest`.

Generally, the action is used like this 👇

[source, yaml]

----

jobs:

  job:

    steps:

      - name: Execute HTTP requests

        uses: madhead/intellij-http-client-action@latest

        with:

          files: |-

            request1.http

            request2.http

          env_file: environments.json

          env: test

          env_variables: |-

            var1=value1

            var2=value2

          insecure: true

----

String and boolean values, like `--env` and `--insecure`, are passed as usually.

List values, like `--files` or `--env-variables`, are passed as https://yaml-multiline.info[YAML multiline strings] ⚠️ 

See link:.github/workflows/ci.yml[the test workflow] for a complete example.

It has https://www.jetbrains.com/help/idea/exploring-http-syntax.html#http_request_names[named tests], tests with https://www.jetbrains.com/help/idea/exploring-http-syntax.html#using_request_vars[variables & environments], tests with https://www.jetbrains.com/help/idea/exploring-http-syntax.html#response-handling[response handlers], etc.

== Issues

Do you have an issue or a question?

Do not hesitate https://github.com/madhead/intellij-http-client-action/issues/new[reporting it]!

Providing a minimal reproducible example in link:.github/workflows/ci.yml[the test workflow] is highly appreciated 👐