https://github.com/k2tzumi/runn-action
:octocat: GitHub Action for runn
https://github.com/k2tzumi/runn-action
automation db-client github-actions grpc-client hacktoberfest http-client scenario-testing testing
Last synced: about 2 months ago
JSON representation
:octocat: GitHub Action for runn
- Host: GitHub
- URL: https://github.com/k2tzumi/runn-action
- Owner: k2tzumi
- License: mit
- Created: 2022-08-28T04:38:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-05T02:57:58.000Z (3 months ago)
- Last Synced: 2026-04-05T04:19:52.616Z (3 months ago)
- Topics: automation, db-client, github-actions, grpc-client, hacktoberfest, http-client, scenario-testing, testing
- Homepage:
- Size: 175 KB
- Stars: 12
- Watchers: 1
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## ⚠️ Important: License Compliance Notice
**CRITICAL:** Versions `v0.71.0` through `v0.138.0` of runn contain AGPL-3.0 licensed code.
### Affected Versions
- ❌ **v0.71.0 - v0.138.0**: Contains AGPL-3.0 licensed dependencies
### Safe Versions
- ✅ **v0.139.0 or later** (Recommended - **now default**)
- ✅ **v0.70.0 or earlier**
### What This Means
The affected versions of runn contain AGPL-3.0 licensed dependencies. While using runn as an external testing tool (without modifying or distributing it) typically does not trigger AGPL-3.0 obligations, we recommend consulting with your legal counsel to understand the implications for your specific use case.
### Current Behavior
- **Now (Phase 1)**: Warning message displayed, workflow continues
- **Future (Phase 2)**: These versions will be blocked with an error
### Migration
If you're using affected versions, update your workflow:
```yaml
- uses: k2tzumi/runn-action@v1
with:
version: 'v0.139.0' # ✅ Safe version (new default)
path_pattern: 'testdata/**/*.yml'
```
For details, see [runn Issue #1319](https://github.com/k1LoW/runn/issues/1319).
# runn-action
:octocat: GitHub Action for [runn](https://github.com/k1LoW/runn)
## Usage
Add scenario file to your repository.
And set up a workflow file as follows and run runn on GitHub Actions.
The actions of the runn command are executed in the container.
``` yaml
# .github/workflows/ci.yml
name: API scenario Test
on:
push:
branches:
- main
pull_request:
jobs:
test:
runs-on: ubuntu-latest
services:
httpbin:
image: kennethreitz/httpbin:latest
ports:
- 8080:80
steps:
-
uses: actions/checkout@v4
-
uses: k2tzumi/runn-action@latest
with:
path_pattern: testdata/path/to/*.yml
env:
# Override parameters in scenario with environment variables
# NOTE: Specify `172.17.0.1` when accessing services on the GitHub Actions host.
END_POINT: http://172.17.0.1:8080/
```
# Action parameters
- `command`
`Required` `run` a scenario by specifying run.
`list` the contents of a scenario by specifying list.
If `loadt` is specified, the scenario can be used as a load test.
Default is `run`.
- `path_pattern`
`Required` Specify the path to the Runbook ( runn scenario file ).
- `github-token`
The GitHub token. Default is `${{ github.token }}`.
- `debug`
Enable runtime debug output. Default is `false`.
- `verbose`
Enable detailed progress output. Default is `false`.
- `version`
This parameter specifies the version of runn.
If this parameter is omitted, runn-action automatically selects and runs the same version of runn as its own version.
- `fail-fast`
Terminates the process if a step in the scenario fails in the middle of a step. Default is `false`.
- `skip-test`
Scenario runs, but test is not evaluated. Default is `false`.
- `shuffle`
Shuffle multiple Runbooks to run with the runn command. Default is `false`.
- `concurrent`
Enable concurrent execution. Default is `false`.
- `enable-read-parent-scope`
Enable `read:parent` scope. Default is `false`.
- `enable-read-remote-scope`
Enable `read:remote` scope. Default is `false`.
- `enable-run-exec-scope`
Enable `run:exec` scope. Default is `false`.
- `labels`
Specify a label to narrow down the target of execution. Multiple labels can be separated by commas.
See [action.yml](action.yml) and [runn README](https://github.com/k1LoW/runn) for more details on how to runbook it.