https://github.com/joscha/sauce-connect-buildkite-plugin
A Buildkite plugin to start a sauce-connect tunnel with
https://github.com/joscha/sauce-connect-buildkite-plugin
buildkite buildkite-plugin sauce-connect sauce-tunnel saucelabs
Last synced: 6 months ago
JSON representation
A Buildkite plugin to start a sauce-connect tunnel with
- Host: GitHub
- URL: https://github.com/joscha/sauce-connect-buildkite-plugin
- Owner: joscha
- License: mit
- Created: 2018-04-28T06:21:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-31T06:53:09.000Z (about 5 years ago)
- Last Synced: 2025-04-13T01:55:24.992Z (6 months ago)
- Topics: buildkite, buildkite-plugin, sauce-connect, sauce-tunnel, saucelabs
- Language: Shell
- Size: 59.6 KB
- Stars: 3
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sauce Connect Buildkite Plugin [](https://travis-ci.org/joscha/sauce-connect-buildkite-plugin)
A [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugins) that opens a [sauce-connect tunnel](https://wiki.saucelabs.com/display/DOCS/Sauce+Connect+Proxy).
It contains a [pre-command hook](hooks/pre-command), [pre-exit hook](hooks/pre-exit), and [tests](tests/command.bats) using [plugin-tester](https://github.com/buildkite-plugins/plugin-tester).
## Example
It looks like this on success:
And like this on a connection failure:
## Usage
```yml
steps:
- command: 'yarn && yarn saucelabs-based-tests'
plugins:
- joscha/sauce-connect#v3.2.3: ~
```
## Configuration
### `tunnel-identifier` (optional)
The tunnel identifier to use, by default it will use the Buildkite Job ID (`BUILDKITE_JOB_ID`)
```yml
steps:
- command: 'yarn && yarn saucelabs-based-tests'
plugins:
- joscha/sauce-connect#v3.2.3:
tunnel-identifier: "my-custom-tunnel-id"
```
### `sauce-connect-version` (optional)
The Sauce Connect version to use, available versions, see [here](https://wiki.saucelabs.com/display/DOCS/Sauce+Connect+Proxy).
```yml
steps:
- command: 'yarn && yarn saucelabs-based-tests'
plugins:
- joscha/sauce-connect#v3.2.3:
sauce-connect-version: "4.4.12"
```
### `force-upload-logs` (optional)
Whether to force log upload or not. In the error case logs are automatically uploaded, this flag allows you to upload logs also in the success case.
```yml
steps:
- command: 'yarn && yarn saucelabs-based-tests'
plugins:
- joscha/sauce-connect#v3.2.3:
force-upload-logs: true
```
## Tests
To run the tests, run `.ci/test.sh`
## Lint
* Plugin: `.ci/lint-plugin.sh`
* Shell files `.ci/lint-shell.sh`
## License
MIT (see [LICENSE](LICENSE))