From 485fe28915b179582093955f7e5a49c4a5f2f27c Mon Sep 17 00:00:00 2001 From: Shivam Mathur Date: Fri, 6 Sep 2019 05:48:51 +0530 Subject: [PATCH] Add README and LICENSE --- LICENSE | 22 +++++++++++++++++ README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++ docs/contributors.md | 2 +- 3 files changed, 82 insertions(+), 1 deletion(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..02f0225a --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ + +The MIT License (MIT) + +Copyright (c) 2019 shivammathur and contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index e69de29b..d77d6991 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,59 @@ +# setup-php + +

+ GitHub Actions status +

+ +This action sets up a php environment for use in actions by: + +- optionally installing a version of PHP and adding to PATH. Along with php it also installs composer + +# Usage + +See [action.yml](action.yml) + +Basic: +```yaml +steps: +- name: Checkout + uses: actions/checkout@master +- name: Installing PHP + uses: shivammathur/setup-php@master + with: + php-version: 7.3 +- name: Check PHP Version + run: php -v +- name: Check Composer Version + run: composer -V +``` + +Matrix Testing: +```yaml +jobs: + run: + runs-on: ${{ matrix.operating-system }} + strategy: + max-parallel: 15 + matrix: + operating-system: [ubuntu-latest, windows-latest, macOS-latest] + php-versions: ['5.6', '7.0', '7.1', '7.2', '7.3'] + name: PHP ${{ matrix.php-versions }} Test + steps: + - name: Checkout + uses: actions/checkout@master + - name: Install PHP + uses: shivammathur/setup-php@develop + with: + php-version: ${{ matrix.php-versions }} + - name: Check PHP Version + run: php -v + +``` + +# License + +The scripts and documentation in this project are released under the [MIT License](LICENSE) + +# Contributions + +Contributions are welcome! See [Contributor's Guide](docs/contributors.md) \ No newline at end of file diff --git a/docs/contributors.md b/docs/contributors.md index 981bdde9..4ebb8c26 100644 --- a/docs/contributors.md +++ b/docs/contributors.md @@ -1,3 +1,3 @@ # Contributors -Please submit a PR to the develop branch \ No newline at end of file +Please submit a Pull Request to the develop branch \ No newline at end of file