Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add an installation step for GitHub Actions #1358

Merged
merged 2 commits into from
Apr 23, 2024
Merged

docs: Add an installation step for GitHub Actions #1358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef0a182
docs: Add an installation step for GitHub Actions
theofidry Apr 23, 2024
7961622
fix link
theofidry Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading