Skip to content

Commit 6e15be1

Browse files
committed
Automate README.md modules generation
1 parent 60555c3 commit 6e15be1

File tree

2 files changed

+27
-7
lines changed

2 files changed

+27
-7
lines changed

Makefile

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,12 +202,34 @@ test-integration:
202202
.PHONY: gen-readme
203203
gen-readme: check-version-is-set
204204
gen-readme: check-stage-is-set
205-
gen-readme:
205+
gen-readme: _gen-readme-docs
206+
gen-readme: _gen-readme-main
207+
208+
.PHONY: _gen-readme-docs
209+
_gen-readme-docs:
206210
@echo "################################################################################"
207-
@echo "# Generate README.md for PHP $(VERSION) ($(IMAGE):$(DOCKER_TAG)) on $(ARCH)"
211+
@echo "# Generate doc/php-modules.md for PHP $(VERSION) ($(IMAGE):$(DOCKER_TAG)) on $(ARCH)"
208212
@echo "################################################################################"
209213
./bin/gen-readme.sh $(IMAGE) $(ARCH) $(STAGE) $(VERSION) || bash -x ./bin/gen-readme.sh $(IMAGE) $(ARCH) $(STAGE) $(VERSION)
210214
git diff --quiet || { echo "Build Changes"; git diff; git status; false; }
215+
@echo
216+
217+
.PHONY: _gen-readme-main
218+
_gen-readme-main:
219+
@echo "################################################################################"
220+
@echo "# Generate README.md"
221+
@echo "################################################################################"
222+
MODULES="$$( cat doc/php-modules.md \
223+
| grep href \
224+
| sed -e 's|</a.*||g' -e 's|.*">||g' \
225+
| sort -fu \
226+
| xargs -n1 sh -c 'echo "[\`$$1\`](php_modules/$$(echo "$${1}" | tr "[:upper:]" "[:lower:]")/)"' -- )"; \
227+
cat "README.md" \
228+
| perl -0 -pe "s#<!-- modules -->.*<!-- /modules -->#<!-- modules -->\n$${MODULES}\n<!-- /modules -->#s" \
229+
> "README.md.tmp"
230+
yes | mv -f "README.md.tmp" "README.md"
231+
git diff --quiet || { echo "Build Changes"; git diff; git status; false; }
232+
@echo
211233

212234
###
213235
### Generate Modules

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,8 @@ The provided Docker images heavily rely on inheritance to guarantee smallest pos
8484
<h2><img id="php-extensions" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Available PHP extensions</h2>
8585

8686
> Click below listed extensions for details:
87-
<!--
88-
Generate via:
89-
cat doc/php_modules.md | grep href | sed 's|</a.*||g' | sed 's|.*">||g' | xargs -n1 sh -c 'echo "[\`$1\`](php_modules/$(echo "${1}" | tr "[:upper:]" "[:lower:]")/)"' -- | xclip
90-
-->
9187
88+
<!-- modules -->
9289
[`amqp`](php_modules/amqp/)
9390
[`apc`](php_modules/apc/)
9491
[`apcu`](php_modules/apcu/)
@@ -180,8 +177,8 @@ cat doc/php_modules.md | grep href | sed 's|</a.*||g' | sed 's|.*">||g' | xargs
180177
[`tokenizer`](php_modules/tokenizer/)
181178
[`uploadprogress`](php_modules/uploadprogress/)
182179
[`uuid`](php_modules/uuid/)
183-
[`wddx`](php_modules/wddx/)
184180
[`vips`](php_modules/vips/)
181+
[`wddx`](php_modules/wddx/)
185182
[`Xdebug`](php_modules/xdebug/)
186183
[`xlswriter`](php_modules/xlswriter/)
187184
[`xml`](php_modules/xml/)
@@ -192,6 +189,7 @@ cat doc/php_modules.md | grep href | sed 's|</a.*||g' | sed 's|.*">||g' | xargs
192189
[`yaml`](php_modules/yaml/)
193190
[`zip`](php_modules/zip/)
194191
[`zlib`](php_modules/zlib/)
192+
<!-- /modules -->
195193

196194
:information_source: For details see **[Documentation: PHP Modules](doc/php-modules.md)**<br/>
197195
:information_source: For details see **[Contributor Documentation: PHP Modules](php_modules/README.md)**

0 commit comments

Comments
 (0)