Skip to content

Commit

Permalink
docs: Add an installation step for GitHub Actions (#1358)
Browse files Browse the repository at this point in the history
  • Loading branch information
theofidry authored Apr 23, 2024
1 parent 68c1ba7 commit 5230802
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)](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)
Expand Down
14 changes: 14 additions & 0 deletions doc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
1. [Homebrew](#homebrew)
1. [GitHub](#github)
1. [Docker](#docker)
1. [shivammathur/setup-php (GitHub Actions)](#shivammathursetup-php-github-actions)


## Phive
Expand Down Expand Up @@ -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
```
<br />
<hr />
Expand All @@ -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

0 comments on commit 5230802

Please sign in to comment.