|
| 1 | +# Contribuir |
| 2 | + |
| 3 | +## Compilar PHP |
| 4 | + |
| 5 | +### Con Docker (Linux) |
| 6 | + |
| 7 | +Construya la imagen Docker de desarrollo: |
| 8 | + |
| 9 | +```console |
| 10 | +docker build -t frankenphp-dev -f dev.Dockerfile . |
| 11 | +docker run --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -p 8080:8080 -p 443:443 -p 443:443/udp -v $PWD:/go/src/app -it frankenphp-dev |
| 12 | +``` |
| 13 | + |
| 14 | +La imagen contiene las herramientas de desarrollo habituales (Go, GDB, Valgrind, Neovim...) y utiliza las siguientes ubicaciones de configuración de PHP: |
| 15 | + |
| 16 | +- php.ini: `/etc/frankenphp/php.ini` Se proporciona un archivo php.ini con ajustes preestablecidos de desarrollo por defecto. |
| 17 | +- archivos de configuración adicionales: `/etc/frankenphp/php.d/*.ini` |
| 18 | +- extensiones php: `/usr/lib/frankenphp/modules/` |
| 19 | + |
| 20 | +Si su versión de Docker es inferior a 23.0, la construcción fallará debido a un [problema de patrón](https://github.com/moby/moby/pull/42676) en `.dockerignore`. Agregue los directorios a `.dockerignore`: |
| 21 | + |
| 22 | +```patch |
| 23 | + !testdata/*.php |
| 24 | + !testdata/*.txt |
| 25 | ++!caddy |
| 26 | ++!internal |
| 27 | +``` |
| 28 | + |
| 29 | +### Sin Docker (Linux y macOS) |
| 30 | + |
| 31 | +[Siga las instrucciones para compilar desde las fuentes](compile.md) y pase la bandera de configuración `--debug`. |
| 32 | + |
| 33 | +## Ejecutar la suite de pruebas |
| 34 | + |
| 35 | +```console |
| 36 | +go test -tags watcher -race -v ./... |
| 37 | +``` |
| 38 | + |
| 39 | +## Módulo Caddy |
| 40 | + |
| 41 | +Construir Caddy con el módulo FrankenPHP: |
| 42 | + |
| 43 | +```console |
| 44 | +cd caddy/frankenphp/ |
| 45 | +go build -tags watcher,brotli,nobadger,nomysql,nopgx |
| 46 | +cd ../../ |
| 47 | +``` |
| 48 | + |
| 49 | +Ejecutar Caddy con el módulo FrankenPHP: |
| 50 | + |
| 51 | +```console |
| 52 | +cd testdata/ |
| 53 | +../caddy/frankenphp/frankenphp run |
| 54 | +``` |
| 55 | + |
| 56 | +El servidor está configurado para escuchar en la dirección `127.0.0.1:80`: |
| 57 | + |
| 58 | +> [!NOTE] |
| 59 | +> |
| 60 | +> Si está usando Docker, deberá enlazar el puerto 80 del contenedor o ejecutar desde dentro del contenedor. |
| 61 | +
|
| 62 | +```console |
| 63 | +curl -vk http://127.0.0.1/phpinfo.php |
| 64 | +``` |
| 65 | + |
| 66 | +## Servidor de prueba mínimo |
| 67 | + |
| 68 | +Construir el servidor de prueba mínimo: |
| 69 | + |
| 70 | +```console |
| 71 | +cd internal/testserver/ |
| 72 | +go build |
| 73 | +cd ../../ |
| 74 | +``` |
| 75 | + |
| 76 | +Iniciar el servidor de prueba: |
| 77 | + |
| 78 | +```console |
| 79 | +cd testdata/ |
| 80 | +../internal/testserver/testserver |
| 81 | +``` |
| 82 | + |
| 83 | +El servidor está configurado para escuchar en la dirección `127.0.0.1:8080`: |
| 84 | + |
| 85 | +```console |
| 86 | +curl -v http://127.0.0.1:8080/phpinfo.php |
| 87 | +``` |
| 88 | + |
| 89 | +## Construir localmente las imágenes Docker |
| 90 | + |
| 91 | +Mostrar el plan de compilación: |
| 92 | + |
| 93 | +```console |
| 94 | +docker buildx bake -f docker-bake.hcl --print |
| 95 | +``` |
| 96 | + |
| 97 | +Construir localmente las imágenes FrankenPHP para amd64: |
| 98 | + |
| 99 | +```console |
| 100 | +docker buildx bake -f docker-bake.hcl --pull --load --set "*.platform=linux/amd64" |
| 101 | +``` |
| 102 | + |
| 103 | +Construir localmente las imágenes FrankenPHP para arm64: |
| 104 | + |
| 105 | +```console |
| 106 | +docker buildx bake -f docker-bake.hcl --pull --load --set "*.platform=linux/arm64" |
| 107 | +``` |
| 108 | + |
| 109 | +Construir desde cero las imágenes FrankenPHP para arm64 y amd64 y subirlas a Docker Hub: |
| 110 | + |
| 111 | +```console |
| 112 | +docker buildx bake -f docker-bake.hcl --pull --no-cache --push |
| 113 | +``` |
| 114 | + |
| 115 | +## Depurar errores de segmentación con las compilaciones estáticas |
| 116 | + |
| 117 | +1. Descargue la versión de depuración del binario FrankenPHP desde GitHub o cree su propia compilación estática incluyendo símbolos de depuración: |
| 118 | + |
| 119 | + ```console |
| 120 | + docker buildx bake \ |
| 121 | + --load \ |
| 122 | + --set static-builder.args.DEBUG_SYMBOLS=1 \ |
| 123 | + --set "static-builder.platform=linux/amd64" \ |
| 124 | + static-builder |
| 125 | + docker cp $(docker create --name static-builder-musl dunglas/frankenphp:static-builder-musl):/go/src/app/dist/frankenphp-linux-$(uname -m) frankenphp |
| 126 | + ``` |
| 127 | + |
| 128 | +2. Reemplace su versión actual de `frankenphp` por el ejecutable de depuración de FrankenPHP. |
| 129 | +3. Inicie FrankenPHP como de costumbre (alternativamente, puede iniciar FrankenPHP directamente con GDB: `gdb --args frankenphp run`). |
| 130 | +4. Adjunte el proceso con GDB: |
| 131 | + |
| 132 | + ```console |
| 133 | + gdb -p `pidof frankenphp` |
| 134 | + ``` |
| 135 | + |
| 136 | +5. Si es necesario, escriba `continue` en el shell de GDB. |
| 137 | +6. Haga que FrankenPHP falle. |
| 138 | +7. Escriba `bt` en el shell de GDB. |
| 139 | +8. Copie la salida. |
| 140 | + |
| 141 | +## Depurar errores de segmentación en GitHub Actions |
| 142 | + |
| 143 | +1. Abrir `.github/workflows/tests.yml` |
| 144 | +2. Activar los símbolos de depuración de la biblioteca PHP: |
| 145 | + |
| 146 | + ```patch |
| 147 | + - uses: shivammathur/setup-php@v2 |
| 148 | + # ... |
| 149 | + env: |
| 150 | + phpts: ts |
| 151 | + + debug: true |
| 152 | + ``` |
| 153 | + |
| 154 | +3. Activar `tmate` para conectarse al contenedor: |
| 155 | + |
| 156 | + ```patch |
| 157 | + - name: Set CGO flags |
| 158 | + run: echo "CGO_CFLAGS=$(php-config --includes)" >> "$GITHUB_ENV" |
| 159 | + + - run: | |
| 160 | + + sudo apt install gdb |
| 161 | + + mkdir -p /home/runner/.config/gdb/ |
| 162 | + + printf "set auto-load safe-path /\nhandle SIG34 nostop noprint pass" > /home/runner/.config/gdb/gdbinit |
| 163 | + + - uses: mxschmitt/action-tmate@v3 |
| 164 | + ``` |
| 165 | + |
| 166 | +4. Conectarse al contenedor. |
| 167 | +5. Abrir `frankenphp.go`. |
| 168 | +6. Activar `cgosymbolizer`: |
| 169 | + |
| 170 | + ```patch |
| 171 | + - //_ "github.com/ianlancetaylor/cgosymbolizer" |
| 172 | + + _ "github.com/ianlancetaylor/cgosymbolizer" |
| 173 | + ``` |
| 174 | + |
| 175 | +7. Descargar el módulo: `go get`. |
| 176 | +8. Dentro del contenedor, puede usar GDB y similares: |
| 177 | + |
| 178 | + ```console |
| 179 | + go test -tags watcher -c -ldflags=-w |
| 180 | + gdb --args frankenphp.test -test.run ^MyTest$ |
| 181 | + ``` |
| 182 | + |
| 183 | +9. Cuando el error esté corregido, revierta todos los cambios. |
| 184 | + |
| 185 | +## Recursos diversos para el desarrollo |
| 186 | + |
| 187 | +- [Integración de PHP en uWSGI](https://github.com/unbit/uwsgi/blob/master/plugins/php/php_plugin.c) |
| 188 | +- [Integración de PHP en NGINX Unit](https://github.com/nginx/unit/blob/master/src/nxt_php_sapi.c) |
| 189 | +- [Integración de PHP en Go (go-php)](https://github.com/deuill/go-php) |
| 190 | +- [Integración de PHP en Go (GoEmPHP)](https://github.com/mikespook/goemphp) |
| 191 | +- [Integración de PHP en C++](https://gist.github.com/paresy/3cbd4c6a469511ac7479aa0e7c42fea7) |
| 192 | +- [Extending and Embedding PHP por Sara Golemon](https://books.google.fr/books?id=zMbGvK17_tYC&pg=PA254&lpg=PA254#v=onepage&q&f=false) |
| 193 | +- [¿Qué es TSRMLS_CC, exactamente?](http://blog.golemon.com/2006/06/what-heck-is-tsrmlscc-anyway.html) |
| 194 | +- [Integración de PHP en Mac](https://gist.github.com/jonnywang/61427ffc0e8dde74fff40f479d147db4) |
| 195 | +- [Bindings SDL](https://pkg.go.dev/github.com/veandco/go-sdl2@v0.4.21/sdl#Main) |
| 196 | + |
| 197 | +## Recursos relacionados con Docker |
| 198 | + |
| 199 | +- [Definición del archivo Bake](https://docs.docker.com/build/customize/bake/file-definition/) |
| 200 | +- [`docker buildx build`](https://docs.docker.com/engine/reference/commandline/buildx_build/) |
| 201 | + |
| 202 | +## Comando útil |
| 203 | + |
| 204 | +```console |
| 205 | +apk add strace util-linux gdb |
| 206 | +strace -e 'trace=!futex,epoll_ctl,epoll_pwait,tgkill,rt_sigreturn' -p 1 |
| 207 | +``` |
| 208 | + |
| 209 | +## Traducir la documentación |
| 210 | + |
| 211 | +Para traducir la documentación y el sitio a un nuevo idioma, siga estos pasos: |
| 212 | + |
| 213 | +1. Cree un nuevo directorio con el código ISO de 2 caracteres del idioma en el directorio `docs/` de este repositorio. |
| 214 | +2. Copie todos los archivos `.md` de la raíz del directorio `docs/` al nuevo directorio (siempre use la versión en inglés como fuente de traducción, ya que siempre está actualizada). |
| 215 | +3. Copie los archivos `README.md` y `CONTRIBUTING.md` del directorio raíz al nuevo directorio. |
| 216 | +4. Traduzca el contenido de los archivos, pero no cambie los nombres de los archivos, tampoco traduzca las cadenas que comiencen por `> [!` (es un marcado especial para GitHub). |
| 217 | +5. Cree una Pull Request con las traducciones. |
| 218 | +6. En el [repositorio del sitio](https://github.com/dunglas/frankenphp-website/tree/main), copie y traduzca los archivos de traducción en los directorios `content/`, `data/` y `i18n/`. |
| 219 | +7. Traduzca los valores en el archivo YAML creado. |
| 220 | +8. Abra una Pull Request en el repositorio del sitio. |
0 commit comments