From ef0a182bfb22fa75dfaee2c149ad59ca067f176c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20FIDRY?= Date: Tue, 23 Apr 2024 21:19:08 +0200 Subject: [PATCH 1/2] docs: Add an installation step for GitHub Actions --- README.md | 1 + doc/installation.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index 2b707ff0b..fb77e2b68 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,7 @@ For the full documentation see https://box-project.github.io/box. 1. [Homebrew](doc/installation.md#homebrew) 1. [GitHub](doc/installation.md#github) 1. [Docker](doc/installation.md#docker) + 1. [shivammathur/setup-php (GitHub Actions)](#shivammathursetup-php-github-actions) 1. [Usage](#usage) 1. [Configuration][the configuration documentation] 1. [Base path (`base-path`)](doc/configuration.md#base-path-base-path) diff --git a/doc/installation.md b/doc/installation.md index 82ad70046..3f097d934 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -5,6 +5,7 @@ 1. [Homebrew](#homebrew) 1. [GitHub](#github) 1. [Docker](#docker) +1. [shivammathur/setup-php (GitHub Actions)](#shivammathursetup-php-github-actions) ## Phive @@ -90,6 +91,18 @@ The official docker image for the project is [`boxproject/box`][docker-image]: docker pull boxproject/box ``` +## `shivammathur/setup-php` (GitHub Actions) + +Box is supported as a [shivammathur/setup-php tool]: + +```yaml +- name: Setup PHP with tools + uses: shivammathur/setup-php@v2 + with: + php-version: '8.3' + tools: box +``` +
@@ -102,3 +115,4 @@ docker pull boxproject/box [docker-image]: https://hub.docker.com/r/boxproject/box [bamarni/composer-bin-plugin]: https://github.com/bamarni/composer-bin-plugin [phive]: https://github.com/phar-io/phive +[shivammathur/setup-php tool]: https://github.com/shivammathur/setup-php?tab=readme-ov-file#wrench-tools-support From 7961622e593a697dbe07f93e838de7a4b020dc66 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20FIDRY?= Date: Tue, 23 Apr 2024 21:24:42 +0200 Subject: [PATCH 2/2] fix link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fb77e2b68..6765d288f 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ For the full documentation see https://box-project.github.io/box. 1. [Homebrew](doc/installation.md#homebrew) 1. [GitHub](doc/installation.md#github) 1. [Docker](doc/installation.md#docker) - 1. [shivammathur/setup-php (GitHub Actions)](#shivammathursetup-php-github-actions) + 1. [shivammathur/setup-php (GitHub Actions)](doc/installation.md#shivammathursetup-php-github-actions) 1. [Usage](#usage) 1. [Configuration][the configuration documentation] 1. [Base path (`base-path`)](doc/configuration.md#base-path-base-path)