actions/setup-php
1
0
Fork 0
mirror of https://github.com/shivammathur/setup-php.git synced 2024-11-22 20:01:06 +07:00
Code Issues Packages Projects Releases Wiki Activity

Improve README.md (#6)

Browse Source 
* Improve README.md
This commit is contained in:
Shivam Mathur 2019-09-08 12:53:33 +05:30 committed by GitHub
parent b45c80e26a
commit 9616296853
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -1,34 +1,36 @@
# setup-php # Setup PHP in GitHub Actions
<p align="left"> <p align="left">
<a href="https://github.com/shivammathur/setup-php"><img alt="GitHub Actions status" src="https://github.com/shivammathur/setup-php/workflows/Main%20workflow/badge.svg"></a> <a href="https://github.com/shivammathur/setup-php"><img alt="GitHub Actions status" src="https://github.com/shivammathur/setup-php/workflows/Main%20workflow/badge.svg"></a>
<a href="https://github.com/shivammathur/setup-php/blob/master/LICENSE"><img alt="LICENSE" src="https://img.shields.io/badge/license-MIT-428f7e.svg"></a>
</p> </p>
This action sets up a php environment along with composer and required PHP extensions on multiple platforms for use in github actions. [GitHub Action](https://github.com/features/actions) to install PHP with required extensions and composer. This action can be added as a step in your action workflow and it will setup the PHP environment you need to test your application. Refer to [Usage](#usage) section to see how to use this.
# PHP Version Support ## PHP Versions Support
- 5.6 - 5.6
- 7.0 - 7.0
- 7.1 - 7.1
- 7.2 - 7.2
- 7.3 - 7.3
# Operating Systems Support ## OS Support
- Linux (ubuntu-latest) - Linux `ubuntu-latest`
- Windows (windows-latest) - Windows `windows-latest`
- MacOS (macOS-latest) - MacOS `macOS-latest`
# PHP Extension Support ## PHP Extension Support
- On linux extensions which have the package in apt are installed. - On linux extensions which have the package in apt are installed.
- On Windows and MacOS pecl extensions are installed. - On Windows and MacOS pecl extensions are installed.
- Extensions which are installed along with PHP if specified are enabled. - Extensions which are installed along with PHP if specified are enabled.
- Extensions which cannot be installed gracefully leave an error message in the logs, the action is not interruped. - Extensions which cannot be installed gracefully leave an error message in the logs, the action is not interruped.
# Usage ## Usage
See [action.yml](action.yml) See [action.yml](action.yml)
Basic: ### Basic
```yaml ```yaml
steps: steps:
- name: Checkout - name: Checkout
@ -46,7 +48,8 @@ steps:
run: php -m run: php -m
``` ```
Matrix Testing: ### Matrix Testing
```yaml ```yaml
jobs: jobs:
run: run:
@ -74,10 +77,23 @@ jobs:
``` ```
# License ## License
The scripts and documentation in this project are released under the [MIT License](LICENSE) The scripts and documentation in this project are released under the [MIT License](LICENSE)
# Contributions ## Contributions
Contributions are welcome! See [Contributor's Guide](docs/contributors.md) Contributions are welcome! See [Contributor's Guide](docs/contributors.md)
## This action uses the following works
- [powershell-phpmanager](https://github.com/mlocati/powershell-phpmanager)
- [Homebrew](https://brew.sh/)
- [ppa:ondrej/php](https://launchpad.net/~ondrej/+archive/ubuntu/php)
- [exolnet/homebrew-deprecated](https://github.com/eXolnet/homebrew-deprecated)
## Further Reading
- [About GitHub Actions](https://github.com/features/actions)
- [GitHub Actions Syntax](https://help.github.com/en/articles/workflow-syntax-for-github-actions)
- [Other Awesome Actions](https://github.com/sdras/awesome-actions)