https://github.com/testingbot/testingbot-tunnel-action

Github Action for TestingBot Tunnel
https://github.com/testingbot/testingbot-tunnel-action

github-actions testingbot tunnel

Last synced: 2 months ago
JSON representation

Github Action for TestingBot Tunnel

• Host: GitHub
• URL: https://github.com/testingbot/testingbot-tunnel-action
• Owner: testingbot
• License: mit
• Created: 2021-04-28T09:23:00.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T01:23:59.000Z (over 2 years ago)
• Last Synced: 2025-02-10T14:23:35.683Z (4 months ago)
• Topics: github-actions, testingbot, tunnel
• Language: TypeScript
• Homepage:
• Size: 524 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![PR Checks](https://github.com/testingbot/testingbot-tunnel-action/actions/workflows/main.yml/badge.svg)](https://github.com/testingbot/testingbot-tunnel-action/actions/workflows/main.yml)

# TestingBot Tunnel GitHub Action



  



A GitHub action to launch the [TestingBot Tunnel](https://testingbot.com/support/other/tunnel).

This will download and start the TestingBot Tunnel (Docker Image), allowing you to run tests on the TestingBot browser/device grid.

## Example

```yaml

jobs:

    test:

        runs-on: ubuntu-latest

        name: Action Test

        steps:

            # ...

            - uses: testingbot/[email protected]

              with:

                  key: ${{ secrets.TB_KEY }}

                  secret: ${{ secrets.TB_SECRET }}

                  tunnelIdentifier: github-action-tunnel

            # ...

```

## Inputs

### `key`:

**Required** Your TestingBot API Key

### `secret`:

**Required** Your TestingBot API Secret

### `auth`:

Performs Basic Authentication for specific hosts, only works with HTTP.

### `debug`:

Enables debug messages. Will output request/response headers.

### `dns`:

Use a custom DNS server. For example: 8.8.8.8

### `doctor`:

Perform sanity/health checks to detect possible misconfiguration or problems.

### `fastFailRegexps`:

Specify domains you don't want to proxy, comma separated.

### `pac`:

Proxy autoconfiguration. Should be a http(s) URL

### `sePort`:

The local port your Selenium test should connect to. Default port is 4445

### `localProxy`:

The port to launch the local proxy on (default 8087).

### `proxy`:

Specify an upstream proxy: PROXYHOST:PROXYPORT

### `proxyCredentials`:

Username and password required to access the proxy configured with `proxy`.

### `noCache`:

Bypass TestingBot Caching Proxy running on the tunnel VM.

### `noProxy`:

Do not start a local proxy (requires user provided proxy server on port 8087).

### `tunnelIdentifier`:

Add an identifier to this tunnel connection.

In case of multiple tunnels, specify this identifier in your desired capabilities to use this specific tunnel.

### `uploadLogFile`:

Should this action upload the log file generated by the TestingBot Tunnel as an artifact?

Default is true.

### `retryTimeout`:

How long, in seconds, should the Action wait if the tunnel fails to start.

## Feature requests and bug reports

Please file feature requests and bug reports as [github issues](https://github.com/testingbot/testingbot-tunnel-action/issues).