From e4fc767f9c57cc7357389e8d2fa9ad468423f1d2 Mon Sep 17 00:00:00 2001 From: Shivam Mathur Date: Mon, 9 Dec 2019 10:52:43 +0530 Subject: [PATCH] Deprecate extension-csv and ini-values-csv inputs --- .github/workflows/experimental-workflow.yml | 4 ++-- .github/workflows/workflow.yml | 4 ++-- README.md | 16 ++++++++-------- __tests__/install.test.ts | 8 ++++---- action.yml | 13 +++++++++++-- dist/index.js | 6 ++++-- examples/codeigniter.yml | 2 +- examples/laravel-mysql.yml | 2 +- examples/laravel-postgres.yml | 2 +- examples/laravel.yml | 2 +- examples/lumen-mysql.yml | 2 +- examples/lumen-postgres.yml | 2 +- examples/lumen.yml | 2 +- examples/phalcon-mysql.yml | 2 +- examples/phalcon-postgres.yml | 2 +- examples/sage.yml | 2 +- examples/slim-framework.yml | 2 +- examples/symfony-mysql.yml | 2 +- examples/symfony-postgres.yml | 2 +- examples/symfony.yml | 2 +- examples/yii2-mysql.yml | 2 +- examples/yii2-postgres.yml | 2 +- examples/zend-framework.yml | 2 +- src/install.ts | 8 ++++++-- 24 files changed, 54 insertions(+), 39 deletions(-) diff --git a/.github/workflows/experimental-workflow.yml b/.github/workflows/experimental-workflow.yml index ff28e0a7..4b2f7335 100644 --- a/.github/workflows/experimental-workflow.yml +++ b/.github/workflows/experimental-workflow.yml @@ -59,8 +59,8 @@ jobs: run: node dist/index.js env: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, xdebug, pcov #optional - ini-values-csv: post_max_size=256M, short_open_tag=On, date.timezone=Asia/Kolkata #optional + extensions: mbstring, xdebug, pcov #optional + ini-values: post_max_size=256M, short_open_tag=On, date.timezone=Asia/Kolkata #optional - name: Testing PHP version run: | diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml index 9304aac2..2ee9edbf 100644 --- a/.github/workflows/workflow.yml +++ b/.github/workflows/workflow.yml @@ -57,8 +57,8 @@ jobs: run: node dist/index.js env: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, xdebug, pcov #optional - ini-values-csv: post_max_size=256M, short_open_tag=On, date.timezone=Asia/Kolkata #optional + extensions: mbstring, xdebug, pcov #optional + ini-values: post_max_size=256M, short_open_tag=On, date.timezone=Asia/Kolkata #optional - name: Testing PHP version run: | diff --git a/README.md b/README.md index d7a9f4ac..0912539b 100644 --- a/README.md +++ b/README.md @@ -84,14 +84,14 @@ with: Specify `coverage: pcov` to use `PCOV`. It is much faster than `Xdebug`. `PCOV` needs `PHP >= 7.1`. -If your source code directory is other than `src`, `lib` or, `app`, specify `pcov.directory` using the `ini-values-csv` input. +If your source code directory is other than `src`, `lib` or, `app`, specify `pcov.directory` using the `ini-values` input. ```yaml uses: shivammathur/setup-php@v1 with: php-version: '7.4' - ini-values-csv: pcov.directory=api #optional, see above for usage. + ini-values: pcov.directory=api #optional, see above for usage. coverage: pcov ``` @@ -116,8 +116,8 @@ with: Inputs supported by this GitHub Action. - php-version `required` -- extension-csv `optional` -- ini-values-csv `optional` +- extension `optional` +- ini-values `optional` - coverage `optional` - pecl `optional` @@ -134,8 +134,8 @@ steps: uses: shivammathur/setup-php@v1 with: php-version: '7.4' - extension-csv: mbstring, intl #optional, setup extensions - ini-values-csv: post_max_size=256M, short_open_tag=On #optional, setup php.ini configuration + extensions: mbstring, intl #optional, setup extensions + ini-values: post_max_size=256M, short_open_tag=On #optional, setup php.ini configuration coverage: xdebug #optional, setup coverage driver pecl: false #optional, setup PECL ``` @@ -159,8 +159,8 @@ jobs: uses: shivammathur/setup-php@v1 with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, intl #optional, setup extensions - ini-values-csv: post_max_size=256M, short_open_tag=On #optional, setup php.ini configuration + extensions: mbstring, intl #optional, setup extensions + ini-values: post_max_size=256M, short_open_tag=On #optional, setup php.ini configuration coverage: xdebug #optional, setup coverage driver pecl: false #optional, setup PECL ``` diff --git a/__tests__/install.test.ts b/__tests__/install.test.ts index bbd93a49..a4077873 100644 --- a/__tests__/install.test.ts +++ b/__tests__/install.test.ts @@ -10,8 +10,8 @@ jest.mock('../src/install', () => ({ version: string, os_version: string ): Promise => { - const extension_csv: string = process.env['extension-csv'] || ''; - const ini_values_csv: string = process.env['ini-values-csv'] || ''; + const extension_csv: string = process.env['extensions'] || ''; + const ini_values_csv: string = process.env['ini-values'] || ''; const coverage_driver: string = process.env['coverage'] || ''; let script = 'initial script ' + filename + version + os_version; @@ -77,8 +77,8 @@ function setEnv( ): void { process.env['php-version'] = version; process.env['RUNNER_OS'] = os; - process.env['extension-csv'] = extension_csv; - process.env['ini-values-csv'] = ini_values_csv; + process.env['extensions'] = extension_csv; + process.env['ini-values'] = ini_values_csv; process.env['coverage'] = coverage_driver; process.env['pecl'] = pecl; } diff --git a/action.yml b/action.yml index 4c5ae0b6..fdef48ef 100644 --- a/action.yml +++ b/action.yml @@ -8,10 +8,10 @@ inputs: description: 'Setup PHP version.' default: '7.4' required: true - extension-csv: + extensions: description: 'Setup PHP extensions.' required: false - ini-values-csv: + ini-values: description: 'Add values to php.ini.' required: false coverage: @@ -20,6 +20,15 @@ inputs: pecl: description: 'Setup PECL on ubuntu' required: false + # Deprecated options, do not use. Will not be supported after February 1, 2019. + extension-csv: + description: 'Deprecated! Use extensions instead.' + deprecationMessage: 'The extensions property will not be supported after February 1, 2020. Use extensions instead.' + required: false + ini-values-csv: + description: 'Deprecated! Use ini-values instead.' + deprecationMessage: 'The ini-values property will not be supported after February 1, 2020. Use ini-values instead.' + required: false runs: using: 'node12' main: 'dist/index.js' diff --git a/dist/index.js b/dist/index.js index b2e0bd90..4efa5ec1 100644 --- a/dist/index.js +++ b/dist/index.js @@ -1481,8 +1481,10 @@ const utils = __importStar(__webpack_require__(163)); function build(filename, version, os_version) { return __awaiter(this, void 0, void 0, function* () { // taking inputs - const extension_csv = yield utils.getInput('extension-csv', false); - const ini_values_csv = yield utils.getInput('ini-values-csv', false); + const extension_csv = (yield utils.getInput('extensions', false)) || + (yield utils.getInput('extension-csv', false)); + const ini_values_csv = (yield utils.getInput('ini-values', false)) || + (yield utils.getInput('ini-values-csv', false)); const coverage_driver = yield utils.getInput('coverage', false); let script = yield utils.readScript(filename, version, os_version); if (extension_csv) { diff --git a/examples/codeigniter.yml b/examples/codeigniter.yml index 92cdec0e..36dc5a53 100644 --- a/examples/codeigniter.yml +++ b/examples/codeigniter.yml @@ -15,7 +15,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, intl, curl, dom + extensions: mbstring, intl, curl, dom coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/laravel-mysql.yml b/examples/laravel-mysql.yml index a4647ab6..7314bc94 100644 --- a/examples/laravel-mysql.yml +++ b/examples/laravel-mysql.yml @@ -39,7 +39,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, dom, fileinfo, mysql + extensions: mbstring, dom, fileinfo, mysql coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/laravel-postgres.yml b/examples/laravel-postgres.yml index 24bb3931..1c9769bc 100644 --- a/examples/laravel-postgres.yml +++ b/examples/laravel-postgres.yml @@ -41,7 +41,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, dom, fileinfo, pgsql + extensions: mbstring, dom, fileinfo, pgsql coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/laravel.yml b/examples/laravel.yml index af3f4ad1..b8058e99 100644 --- a/examples/laravel.yml +++ b/examples/laravel.yml @@ -17,7 +17,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, dom, fileinfo + extensions: mbstring, dom, fileinfo coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/lumen-mysql.yml b/examples/lumen-mysql.yml index 0bd7cd64..3a9357d0 100644 --- a/examples/lumen-mysql.yml +++ b/examples/lumen-mysql.yml @@ -39,7 +39,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, dom, fileinfo, mysql + extensions: mbstring, dom, fileinfo, mysql coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/lumen-postgres.yml b/examples/lumen-postgres.yml index 850003c8..459c7fc6 100644 --- a/examples/lumen-postgres.yml +++ b/examples/lumen-postgres.yml @@ -41,7 +41,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, dom, fileinfo, pgsql + extensions: mbstring, dom, fileinfo, pgsql coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/lumen.yml b/examples/lumen.yml index f43bfa1b..6b2984ff 100644 --- a/examples/lumen.yml +++ b/examples/lumen.yml @@ -17,7 +17,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, dom, fileinfo, mysql + extensions: mbstring, dom, fileinfo, mysql coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/phalcon-mysql.yml b/examples/phalcon-mysql.yml index e7d24cda..88f8d821 100644 --- a/examples/phalcon-mysql.yml +++ b/examples/phalcon-mysql.yml @@ -37,7 +37,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, dom, zip, phalcon4, mysql #use phalcon3 for the phalcon 3.x. + extensions: mbstring, dom, zip, phalcon4, mysql #use phalcon3 for the phalcon 3.x. coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/phalcon-postgres.yml b/examples/phalcon-postgres.yml index f64dd3bd..159888ab 100644 --- a/examples/phalcon-postgres.yml +++ b/examples/phalcon-postgres.yml @@ -38,7 +38,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, dom, zip, phalcon4, pgsql #use phalcon3 for the phalcon 3.x + extensions: mbstring, dom, zip, phalcon4, pgsql #use phalcon3 for the phalcon 3.x coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/sage.yml b/examples/sage.yml index 59bc6587..b22ae0f3 100644 --- a/examples/sage.yml +++ b/examples/sage.yml @@ -21,7 +21,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring + extensions: mbstring - name: Check node versions run: node -v - name: Get yarn cache diff --git a/examples/slim-framework.yml b/examples/slim-framework.yml index 3f6c2020..d22bc57c 100644 --- a/examples/slim-framework.yml +++ b/examples/slim-framework.yml @@ -15,7 +15,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, simplexml, dom + extensions: mbstring, simplexml, dom coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/symfony-mysql.yml b/examples/symfony-mysql.yml index c1b2806f..f6e719bd 100644 --- a/examples/symfony-mysql.yml +++ b/examples/symfony-mysql.yml @@ -26,7 +26,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, xml, ctype, iconv, mysql + extensions: mbstring, xml, ctype, iconv, mysql coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/symfony-postgres.yml b/examples/symfony-postgres.yml index 092f5395..7fd3180d 100644 --- a/examples/symfony-postgres.yml +++ b/examples/symfony-postgres.yml @@ -26,7 +26,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, xml, ctype, iconv, pgsql + extensions: mbstring, xml, ctype, iconv, pgsql coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/symfony.yml b/examples/symfony.yml index 15c75850..f9310a6e 100644 --- a/examples/symfony.yml +++ b/examples/symfony.yml @@ -17,7 +17,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, xml, ctype, iconv + extensions: mbstring, xml, ctype, iconv coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/yii2-mysql.yml b/examples/yii2-mysql.yml index e8e1a2cf..117a7797 100644 --- a/examples/yii2-mysql.yml +++ b/examples/yii2-mysql.yml @@ -36,7 +36,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, intl, gd, imagick, zip, dom, mysql + extensions: mbstring, intl, gd, imagick, zip, dom, mysql coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/yii2-postgres.yml b/examples/yii2-postgres.yml index 7c21cb78..87c58f3a 100644 --- a/examples/yii2-postgres.yml +++ b/examples/yii2-postgres.yml @@ -36,7 +36,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, intl, gd, imagick, zip, dom, pgsql + extensions: mbstring, intl, gd, imagick, zip, dom, pgsql coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/examples/zend-framework.yml b/examples/zend-framework.yml index 459368a4..c6f97891 100644 --- a/examples/zend-framework.yml +++ b/examples/zend-framework.yml @@ -15,7 +15,7 @@ jobs: uses: shivammathur/setup-php@v1 #https://github.com/shivammathur/setup-php with: php-version: ${{ matrix.php-versions }} - extension-csv: mbstring, bcmath, curl, intl + extensions: mbstring, bcmath, curl, intl coverage: xdebug #optional - name: Get composer cache directory id: composer-cache diff --git a/src/install.ts b/src/install.ts index 563f2f92..34172400 100644 --- a/src/install.ts +++ b/src/install.ts @@ -18,8 +18,12 @@ export async function build( os_version: string ): Promise { // taking inputs - const extension_csv: string = await utils.getInput('extension-csv', false); - const ini_values_csv: string = await utils.getInput('ini-values-csv', false); + const extension_csv: string = + (await utils.getInput('extensions', false)) || + (await utils.getInput('extension-csv', false)); + const ini_values_csv: string = + (await utils.getInput('ini-values', false)) || + (await utils.getInput('ini-values-csv', false)); const coverage_driver: string = await utils.getInput('coverage', false); let script: string = await utils.readScript(filename, version, os_version);