@@ -4,7 +4,7 @@ description: 'GitHub action to generate PHP project documentation in MarkDown fo
44branding :
55 icon : book
66 color : blue
7-
7+
88inputs :
99 output_path :
1010 description : " Path where to write generated documentation"
@@ -14,54 +14,52 @@ inputs:
1414 required : true
1515 included_classes :
1616 description : " Included classes list (supports glob style wildcards syntax; each line means one rule)"
17- required : true
17+ required : true
1818
1919runs :
2020 using : ' composite'
2121 steps :
22- - name : Creating tmp folder
22+ - name : Creating tmp folder
2323 run : |
2424 rm -rf /tmp/data || true
2525 mkdir -p /tmp/data
2626 shell : bash
27-
27+
2828 - name : Copying current project to tmp folder...
2929 run : cp -R ./* /tmp/data/
3030 shell : bash
31-
31+
3232 - name : Getting PHP class list...
3333 uses :
impresscms-dev/[email protected] 3434 with :
3535 output_file : /tmp/php-classes.original.lst
36-
36+
3737 - name : Generating temp filtering rules file...
3838 uses :
DamianReeves/[email protected] 3939 with :
40- path : /tmp/filtering-rules.lst
41- contents : " {{ input.included_classes }}"
42- write-mode : overwrite
43-
44- - name : Filtering PHP classes list...
45- uses :
impresscms-dev/[email protected] 46- with :
47- rules_file : /tmp/filtering-rules.lst
48- input_file : /tmp/php-classes.original.lst
49- output_file : /tmp/php-classes.filtered.lst
50-
40+ path : /tmp/filtering-rules.lst
41+ contents : " {{ input.included_classes }}"
42+ write-mode : overwrite
43+
44+ - name : Filtering PHP classes list...
45+ uses :
impresscms-dev/[email protected] 46+ with :
47+ rules_file : /tmp/filtering-rules.lst
48+ input_file : /tmp/php-classes.original.lst
49+ output_file : /tmp/php-classes.filtered.lst
50+
5151 - name : Generating generator config...
5252 run : php ${{ github.action_path }}/generate-config.php "/tmp/data/.phpdoc-md" "/tmp/php-classes.filtered.lst" "{{ input.class_root_namespace }}" "{{ input.output_path }}"
5353 shell : bash
54-
54+
5555 - name : Including documentation generator...
56- run : composer require --no-plugins --ignore-platform-reqs --no-scripts --dev 'clean/phpdoc-md=^0.19'
57- working-directory : /tmp/data/
56+ run : composer require --no-plugins --ignore-platform-reqs --no-scripts --working-dir=/tmp/data/ --dev 'clean/phpdoc-md=^0.19'
5857 shell : bash
59-
58+
6059 - name : Generating documentation...
61- run : composer exec phpdoc-md
62- working-directory : /tmp/data/
60+ run : composer exec --working-dir=/tmp/data/ phpdoc-md
6361 shell : bash
64-
62+
6563 - name : Deleting tmp data...
6664 run : |
6765 rm -rf /tmp/data || true
0 commit comments