Skip to content

Commit e009cd3

Browse files
Update README.md
1 parent bc11da9 commit e009cd3

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
11
# workflows.php
22
Default workflos for php projects
3+
4+
## Available Workflows
5+
6+
### CI
7+
8+
Validates composer.json and runs the CI pipelines to verify the project is working correctly. The workflow supports building a matrix of php versions and stabilities. By default prefer-lowest and prefer-stable are tested with all given php versions which should cover most of the package ranges.
9+
10+
#### Inputs
11+
php-versions:
12+
description: 'The php versions to test as JSON array. Will be converted and used to create a matrix.'
13+
default: '["8.1"]'
14+
required: true
15+
type: string
16+
prefer-stability:
17+
description: 'The staibility of the packages to use. Will be converted and used to create a matrix.'
18+
default: '["prefer-lowest", "prefer-stable"]'
19+
type: string
20+
test-command:
21+
description: 'The command to run for executing tests'
22+
default: 'composer ci-all'
23+
type: string
24+
25+
#### Example
26+
27+
```yaml
28+
29+
name: CI
30+
31+
on:
32+
push:
33+
branches:
34+
- main
35+
- release
36+
paths-ignore:
37+
- '**.md'
38+
pull_request:
39+
branches:
40+
- main
41+
- release
42+
paths-ignore:
43+
- '**.md'
44+
45+
jobs:
46+
ci:
47+
uses: codenamephp/workflows.php/.github/workflows/ci.yml@main
48+
with:
49+
php-versions: '["8.1", "8.0"]'
50+
```

0 commit comments

Comments
 (0)