Skip to content

Commit a9dd67c

Browse files
gennadiylitvinyukXerkus
authored andcommitted
Update README.md
Improved usage instructions Fixed docker image name in local usage example Signed-off-by: Gennadiy Litvinyuk <[email protected]>
1 parent 5e0ed7b commit a9dd67c

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
@@ -59,7 +59,19 @@ Generally speaking, you will use this in combination with the [laminas/laminas-c
5959

6060
## Usage
6161

62+
Create `.github/workflows/continuous-integration.yml` file with following content:
63+
6264
```yaml
65+
name: "Continuous Integration"
66+
67+
on:
68+
pull_request:
69+
push:
70+
branches:
71+
- '[0-9]+.[0-9]+.x'
72+
- 'refs/pull/*'
73+
tags:
74+
6375
jobs:
6476
matrix:
6577
name: Generate job matrix
@@ -219,7 +231,7 @@ The tricks to remember are:
219231
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:
220232

221233
```bash
222-
$ docker run -v $(realpath .):/github/workspace -w=/github/workspace laminas-check-runner:latest '{"php":"7.4","dependencies":"locked","extensions":[],"ini":["memory_limit=-1"],"command":"./vendor/bin/phpcs"}'
234+
$ docker run -v $(realpath .):/github/workspace -w=/github/workspace ghcr.io/laminas/laminas-continuous-integration:1 '{"php":"7.4","dependencies":"locked","extensions":[],"ini":["memory_limit=-1"],"command":"./vendor/bin/phpcs"}'
223235
```
224236

225237
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)