2 https://awesomized.github.io/ext-ion
6 1. Edit stub: `$EDITOR ../ion.stub.php`
8 3. [Review](#Review); repeat from 2. if necessary
9 4. [Deploy](#Deployment)
11 ## Howto make a release
19 See [Rebuild](#Rebuild).
22 See [Review](#Review).
24 ### 4. Commit docs with release changelog:
39 ### 6. Release & [deploy](#Deployment):
45 ### Prerequisites without docker:
47 * PHP with ext-http and ext-dom but **without** ext-ion
51 │ BUILD │ ┌──────────┐
52 ┌─┴─────────┴──────────────┐ │ SOURCE │
53 │ $ make #docker UID=$UID ├──►┌──┴──────────┴───────────┐
54 └──────────────────────────┘ │ ../README.md │
56 ┌──────────────────────────────┤ ../... │
57 │ └─────────────────────────┘
59 │ │ PROCESSED BY │ ┌────────────┐
60 ┌▼─┴────────────────┴───────┐ │ MARKDOWN │
61 │ ./vendor/bin/stub2ref ├──►┌──┴────────────┴─────────┐
62 └───────────────────────────┘ │ ./src/mdref.json │
64 ┌──────────────────────────────┤ ./src/ion/... │
65 │ └─────────────────────────┘
67 │ │ PROCESSED BY │ ┌────────┐
68 ┌▼─┴────────────────┴───────┐ │ HTML │
69 │ ./vendor/bin/ref2html ├──►┌──┴────────┴─────────────┐
70 └───────────────────────────┘ │ ./docs/latest -> vX.Y/ │
71 │ ./docs/vX.Y/index.html │
72 │ ./docs/vX.Y/ion/... │
73 └─────────────────────────┘
78 Run caddy to read the docs as they would appear on https://awesomized.github.io/ext-ion.
83 Use `$CADDY_ADDRESS` env var to customize the HTTP endpoint, e.g:
85 CADDY_ADDRESS=localhost:8080 caddy run
88 Use docker, if you do not have caddy installed:
90 docker-compose -f docker/compose.yml run -p 8080:80 caddy
93 Use PHP CLI server if you're desperate:
95 php -S localhost:0 -r . .router.php
102 ┌──┴──────────┴─────────────┐
103 │ $ git add . │ ┌────────────┐
104 │ $ git commit │ │ GH ACTION │
105 │ $ git push ├──►┌──┴────────────┴─────────┐
106 └───────────────────────────┘ │ pages-build-deployment │
107 └─┬───────────────────────┘
110 ┌──┴──────────────┴───────────────▼───────────────────────┐
112 │ https://awesomized.github.io/ext-ion/latest/ │
114 └─────────────────────────────────────────────────────────┘