Skip to content

Commit 67e80f6

Browse files
Update README.md
Improved usage instructions Fixed docker image name in local usage example Signed-off-by: Gennadiy Litvinyuk <[email protected]>
1 parent bd98ea6 commit 67e80f6

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,19 @@ Generally speaking, you will use this in combination with the [laminas/laminas-c
3030

3131
## Usage
3232

33+
Create `.github/workflows/continuous-integration.yml` file with following content:
34+
3335
```yaml
36+
name: "Continuous Integration"
37+
38+
on:
39+
pull_request:
40+
push:
41+
branches:
42+
- '[0-9]+.[0-9]+.x'
43+
- 'refs/pull/*'
44+
tags:
45+
3446
jobs:
3547
matrix:
3648
name: Generate job matrix
@@ -155,7 +167,7 @@ The tricks to remember are:
155167
As an example, if you wanted to run the CS checks under PHP 7.4 using locked dependencies, you could do something like the following:
156168

157169
```bash
158-
$ docker run -v $(realpath .):/github/workspace -w=/github/workspace laminas-check-runner:latest '{"php":"7.4","deps":"locked","extensions":[],"ini":["memory_limit=-1"],"command":"./vendor/bin/phpcs"}'
170+
$ docker run -v $(realpath .):/github/workspace -w=/github/workspace ghcr.io/laminas/laminas-continuous-integration:1 '{"php":"7.4","deps":"locked","extensions":[],"ini":["memory_limit=-1"],"command":"./vendor/bin/phpcs"}'
159171
```
160172

161173
The trick to remember: the job JSON should generally be in single quotes, to allow the `"` characters used to delimit properties and strings in the JSON to not cause interpolation issues.

0 commit comments

Comments
 (0)