Skip to content

Commit

Permalink
chore(readme): minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Tieske committed Oct 24, 2023
1 parent 5b64f1b commit 1321677
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,14 @@ Some more elaborate examples:
```shell
# Run against a specific version of Kong and pass
# a number of Busted options
KONG_VERSION=0.36-1 pongo run -v -o gtest ./spec
KONG_VERSION=3.2.2 pongo run -- -v -o gtest ./spec

# Run against the latest patch version of a Kong release using '.x'
KONG_VERSION=1.2.x pongo run -v -o gtest ./spec
KONG_VERSION=3.4.x pongo run

# Run against the latest stable version, using special label 'stable'
# (available labels are: 'stable', 'stable-ee', 'dev', and 'dev-ee')
KONG_VERSION=stable pongo run

# Run against a local image of Kong
KONG_IMAGE=kong-ee pongo run ./spec
Expand Down Expand Up @@ -613,7 +617,10 @@ After the test run the output files `luacov.*.out` files should be available.
Pongo is easily added to a CI setup. The examples below will asume Travis-CI, but
can be easily converted to other engines.

**Note**: if your engine of preference runs itself in Docker, then checkout [Pongo in Docker](#running-pongo-in-docker).
**Note:**

* For Github the best option is to use [the Pongo Github Action](https://github.com/Kong/kong-pongo-action)
* if your engine of preference runs itself in Docker, then checkout [Pongo in Docker](#running-pongo-in-docker).

Here's a base setup for an open-source plugin that will test against 2 Kong versions:
```yaml
Expand All @@ -623,10 +630,12 @@ dist: bionic
jobs:
include:
- name: Kong CE 2.0.x
env: KONG_VERSION=2.0.x
- name: Kong CE 1.5.x
env: KONG_VERSION=1.5.x
- name: Kong CE 3.3.x
env: KONG_VERSION=3.3.x
- name: Kong CE 3.4.x
env: KONG_VERSION=3.4.x
- name: Kong CE development
env: KONG_VERSION=dev
install:
- git clone --single-branch https://github.com/Kong/kong-pongo ../kong-pongo
Expand Down Expand Up @@ -654,6 +663,8 @@ jobs:
env: KONG_VERSION=dev
```
**Note**: there is also a "`dev-ee`" label, but that is for Kong internal use only.
[Back to ToC](#table-of-contents)
### CI with Kong Enterprise
Expand Down

0 comments on commit 1321677

Please sign in to comment.