Merge pull request #12 from shivammathur/develop

Hotfix in 1.1.1

.eslintrc.json

@@ -1,7 +1,7 @@
 {
   "env": { "node": true, "jest": true },
   "parser": "@typescript-eslint/parser",
-  "parserOptions": { "ecmaVersion": 2020, "sourceType": "module" },
+  "parserOptions": { "ecmaVersion": 2019, "sourceType": "module" },
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/eslint-recommended",

.github/FUNDING.yml

@@ -1,7 +1,5 @@
 # These are supported funding model platforms
 
 github: shivammathur
-issuehunt: shivammathur
 patreon: shivammathur
-liberapay: shivammathur
 custom: https://www.paypal.me/shivammathur

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,23 +1,42 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Nice, you found a bug!
 title: ''
-labels: ''
-assignees: ''
+labels: 'bug'
+assignees: 'shivammathur'
 
 ---
 
 **Describe the bug**
-A clear and concise description of what the bug is.
+<!-- Please describe the bug concisely. -->
+
+**Version**
+- [ ] I have checked releases and the bug exists in the latest patch version of `v1`.
+- [ ] `v2`
+- [ ] `v1`
+
+**Runners**
+<!-- Please mark the GitHub Action runner your workflow uses. -->
+- [ ] GitHub Hosted
+- [ ] Self Hosted
+
+**Operating systems**
+<!-- Please mention the operating systems your workflow uses. -->
+
+**PHP versions**
+<!-- Please mention the PHP versions your workflow uses. -->
 
 **To Reproduce**
-Please provide the GitHub Action `.yml` file.
+<!-- Please provide the relevant steps of your workflow `.yml` file. -->
 
 **Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- A clear and concise description of what you expected to happen. -->
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Screenshots/Logs**
+<!-- If applicable, add screenshots or logs to help explain your problem. -->
 
 **Additional context**
-Add any other context about the problem here.
+<!-- Add any other context about the problem here. -->
+
+**Are you willing to submit a PR?**
+<!-- We accept pull requests targeting the develop branch. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,26 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
+about: Suggest a new feature
 title: ''
-labels: ''
-assignees: ''
+labels: 'enhancement'
+assignees: 'shivammathur'
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I want to improve [...]
+**Describe the feature**
+<!-- Please describe concisely the feature you want to add. -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Version**
+- [ ] I have checked releases and the feature is missing in the latest patch version of `v1`.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Underlying issue**
+<!-- Please describe the issue this would solve. -->
+
+**Describe alternatives**
+<!-- Please mention any alternative solutions you've considered. -->
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+<!-- Add any other context or screenshots about the feature request here. -->
+
+**Are you willing to submit a PR?**
+<!-- We accept pull requests targeting the develop branch. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,14 +7,13 @@ labels: bug or enhancement
 
 ## A Pull Request should be associated with an Issue.
 
-> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
-> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
-> and potentially we'll be able to point development in a particular direction.
+> If you're fixing a bug, adding a new feature or improving something please provide the details in Issues,
+> so that the development can be pointed in the intended direction.
 
-Related issue: 
+Related issue: <!-- Please link the related issue -->
 
 > Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
-> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
+> Thank you for your contribution.
 
 ### Description
 
@@ -26,7 +25,12 @@ This PR [briefly explain what it does]
 - [ ] I have run `npm run format` before the commit.
 - [ ] I have run `npm run lint` before the commit.
 - [ ] I have run `npm run release` before the commit.
-- [ ] `npm test` returns with no unit test errors.
+- [ ] `npm test` returns with no unit test errors and all code covered.
+
+> In case this PR edits any scripts:
+
+- [ ] I have checked the edited scripts for syntax.
+- [ ] I have tested the changes in an integration test (If yes, provide workflow link).
 
 <!--
 - Please target the develop branch when submitting the pull request.

.github/PULL_REQUEST_TEMPLATE/FIX.md

@@ -1,33 +0,0 @@
----
-name: 🐞 Bug Fix
-about: You have a fix for a bug?
-labels: bug
-
----
-
-## A Pull Request should be associated with an Issue.
-
-> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
-> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
-> and potentially we'll be able to point development in a particular direction.
-
-Related issue: 
-
-> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
-> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
-
-### Description
-
-This PR [briefly explain what it does]
-
-> In case this PR introduced TypeScript/JavaScript code changes:
-
-- [ ] I have written test cases for the changes in this pull request.
-- [ ] I have run `npm run format` before the commit.
-- [ ] I have run `npm run lint` before the commit.
-- [ ] I have run `npm run release` before the commit.
-- [ ] `npm test` returns with no unit test errors.
-
-<!--
-- Please target the develop branch when submitting the pull request.
--->

.github/PULL_REQUEST_TEMPLATE/IMPROVEMENT.md

@@ -1,33 +0,0 @@
----
-name: ⚙ Improvement
-about: You have some improvement to make cache-extensions better?
-labels: enhancement
-
----
-
-## A Pull Request should be associated with an Issue.
-
-> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
-> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
-> and potentially we'll be able to point development in a particular direction.
-
-Related issue: 
-
-> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
-> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
-
-### Description
-
-This PR [briefly explain what it does]
-
-> In case this PR introduced TypeScript/JavaScript code changes:
-
-- [ ] I have written test cases for the changes in this pull request.
-- [ ] I have run `npm run format` before the commit.
-- [ ] I have run `npm run lint` before the commit.
-- [ ] I have run `npm run release` before the commit.
-- [ ] `npm test` returns with no unit test errors.
-
-<!--
-- Please target the develop branch when submitting the pull request.
--->

.github/PULL_REQUEST_TEMPLATE/NEW_FEATURE.md

@@ -1,33 +0,0 @@
----
-name: 🎉 New Feature
-about: You have implemented some neat idea that you want to make part of cache-extensions?
-labels: enhancement
-
----
-
-## A Pull Request should be associated with an Issue.
-
-> We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
-> If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
-> and potentially we'll be able to point development in a particular direction.
-
-Related issue: 
-
-> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
-> Thank you! We are open to PRs, but please understand if for technical reasons we are unable to accept each and any PR
-
-### Description
-
-This PR [briefly explain what it does]
-
-> In case this PR introduced TypeScript/JavaScript code changes:
-
-- [ ] I have written test cases for the changes in this pull request.
-- [ ] I have run `npm run format` before the commit.
-- [ ] I have run `npm run lint` before the commit.
-- [ ] I have run `npm run release` before the commit.
-- [ ] `npm test` returns with no unit test errors.
-
-<!--
-- Please target the develop branch when submitting the pull request.
--->

README.md

@@ -14,9 +14,12 @@ Cache PHP extensions in [GitHub Actions](https://github.com/features/actions "Gi
 - [PHP Support](#tada-php-support)
 - [OS/Platform Support](#cloud-osplatform-support)
 - [Usage](#memo-usage)
+  - [Inputs](#inputs)
+  - [Workflow](#workflow)
 - [License](#scroll-license)
 - [Contributions](#1-contributions)
 - [Support this project](#sparkling_heart-support-this-project)
+- [Dependencies](#bookmark-dependencies)
 
 ## :tada: PHP Support
 
@@ -31,27 +34,43 @@ Cache PHP extensions in [GitHub Actions](https://github.com/features/actions "Gi
 |7.2|`Stable`|`Security fixes only`|
 |7.3|`Stable`|`Active`|
 |7.4|`Stable`|`Active`|
-|8.0|`Experimental`|`In development`|
+|8.0|`Nightly`|`In development`|
 
 ## :cloud: OS/Platform Support
 
-|Virtual environment|matrix.operating-system|
+|Virtual environment|YAML workflow label|
 |--- |--- |
 |Windows Server 2019|`windows-latest` or `windows-2019`|
+|Ubuntu 20.04|`ubuntu-20.04`|
 |Ubuntu 18.04|`ubuntu-latest` or `ubuntu-18.04`|
 |Ubuntu 16.04|`ubuntu-16.04`|
-|macOS X Catalina 10.15|`macos-latest` or `macOS-10.15`|
+|macOS Catalina 10.15|`macos-latest` or `macOS-10.15`|
 
 ## :memo: Usage
 
-Inputs supported by this GitHub Action.
+### Inputs
 
-- php-version `required`
-- extensions `required`
-- key `required`
+#### `php-version` (required)
+
+- Specify the PHP version you want to setup.
+- Accepts a `string`. For example `'7.4'`.
+- See [PHP support](#tada-php-support) for supported PHP versions.
+
+#### `extensions` (required)
+
+- Specify the extensions you want to add or remove.
+- Accepts a `string` in csv-format. For example `mbstring, , xdebug, :opcache`.
+- Extensions prefixed with `:` are ignored.
+
+#### `key` (required)
+
+- Specify the key to identify the cache version.
+- Accepts any `string`. For example `cache-v1`.
+- Changing this would reset the cache.
 
 See [action.yml](action.yml "Metadata for this GitHub Action") and usage below for more info.
 
+### Workflow
 > Cache extensions in a PHP workflow
 
 ```yaml
@@ -71,7 +90,7 @@ jobs:
       uses: actions/checkout@v2
 
     - name: Setup cache environment
-      id: cache-env
+      id: extcache
       uses: shivammathur/cache-extensions@v1
       with:
         php-version: ${{ matrix.php-versions }}
@@ -81,9 +100,9 @@ jobs:
     - name: Cache extensions
       uses: actions/cache@v2
       with:
-        path: ${{ steps.cache-env.outputs.dir }}
-        key: ${{ steps.cache-env.outputs.key }}
-        restore-keys: ${{ steps.cache-env.outputs.key }}
+        path: ${{ steps.extcache.outputs.dir }}
+        key: ${{ steps.extcache.outputs.key }}
+        restore-keys: ${{ steps.extcache.outputs.key }}
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -104,7 +123,11 @@ Contributions are welcome! See [Contributor's Guide](.github/CONTRIBUTING.md "sh
 
 If this action helped you.
 
+- Sponsor the project by subscribing on [Patreon](https://www.patreon.com/shivammathur "Shivam Mathur Patreon") or by contributing using [Paypal](https://www.paypal.me/shivammathur "Shivam Mathur PayPal").
 - Please star the project and share it with the community.
-- If you blog, write about your experience while using this action.
-- I maintain this in my free time, please support me with a [Patreon](https://www.patreon.com/shivammathur "Shivam Mathur Patreon") subscription or a one time contribution using [Paypal](https://www.paypal.me/shivammathur "Shivam Mathur PayPal").
-- If you need any help using this, please contact me using [Codementor](https://www.codementor.io/shivammathur "Shivam Mathur Codementor")
+- If you blog, write about your experience of using this action.
+- If you need any help using this, please contact me using [Codementor](https://www.codementor.io/shivammathur "Shivam Mathur Codementor")u need any help using this, please contact me using [Codementor](https://www.codementor.io/shivammathur "Shivam Mathur Codementor")
+
+## :bookmark: Dependencies
+
+- [Node.js dependencies](https://github.com/shivammathur/setup-php/network/dependencies "Node.js dependencies")

dist/index.js

@@ -987,19 +987,10 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.filterExtensions = exports.getInput = void 0;
 const core = __importStar(__webpack_require__(470));
@@ -1009,17 +1000,15 @@ const core = __importStar(__webpack_require__(470));
  * @param name
  * @param mandatory
  */
-function getInput(name, mandatory) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const input = process.env[name];
-        switch (input) {
-            case '':
-            case undefined:
-                return core.getInput(name, { required: mandatory });
-            default:
-                return input;
-        }
-    });
+async function getInput(name, mandatory) {
+    const input = process.env[name];
+    switch (input) {
+        case '':
+        case undefined:
+            return core.getInput(name, { required: mandatory });
+        default:
+            return input;
+    }
 }
 exports.getInput = getInput;
 /**
@@ -1027,15 +1016,13 @@ exports.getInput = getInput;
  *
  * @param extension_csv
  */
-function filterExtensions(extension_csv) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return extension_csv
-            .split(',')
-            .filter(extension => {
-            return extension.trim()[0] != ':';
-        })
-            .join(',');
-    });
+async function filterExtensions(extension_csv) {
+    return extension_csv
+        .split(',')
+        .filter(extension => {
+        return extension.trim()[0] != ':';
+    })
+        .join(',');
 }
 exports.filterExtensions = filterExtensions;
 
@@ -1620,19 +1607,10 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.run = void 0;
 const exec_1 = __webpack_require__(986);
@@ -1642,20 +1620,18 @@ const utils = __importStar(__webpack_require__(163));
 /**
  * Run the script
  */
-function run() {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            let version = yield utils.getInput('php-version', true);
-            version = version.length > 1 ? version.slice(0, 3) : version + '.0';
-            const extensions = yield utils.filterExtensions(yield utils.getInput('extensions', true));
-            const key = yield utils.getInput('key', true);
-            const script_path = path.join(__dirname, '../src/extensions.sh');
-            yield exec_1.exec('bash ' + script_path + ' "' + extensions + '" ' + key + ' ' + version);
-        }
-        catch (error) {
-            core.setFailed(error.message);
-        }
-    });
+async function run() {
+    try {
+        let version = await utils.getInput('php-version', true);
+        version = version.length > 1 ? version.slice(0, 3) : version + '.0';
+        const extensions = await utils.filterExtensions(await utils.getInput('extensions', true));
+        const key = await utils.getInput('key', true);
+        const script_path = path.join(__dirname, '../src/extensions.sh');
+        await exec_1.exec('bash ' + script_path + ' "' + extensions + '" ' + key + ' ' + version);
+    }
+    catch (error) {
+        core.setFailed(error.message);
+    }
 }
 exports.run = run;
 // call the run function

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cache-extensions",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "private": false,
   "description": "Cache extensions in GitHub Actions",
   "main": "dist/index.js",
@@ -28,22 +28,22 @@
     "@actions/exec": "^1.0.4"
   },
   "devDependencies": {
-    "@types/jest": "^25.2.3",
-    "@types/node": "^14.0.9",
-    "@typescript-eslint/eslint-plugin": "^3.1.0",
-    "@typescript-eslint/parser": "^3.1.0",
+    "@types/jest": "^26.0.5",
+    "@types/node": "^14.0.23",
+    "@typescript-eslint/eslint-plugin": "^3.6.1",
+    "@typescript-eslint/parser": "^3.6.1",
     "@zeit/ncc": "^0.22.3",
-    "eslint": "^7.1.0",
+    "eslint": "^7.4.0",
     "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-jest": "^23.13.2",
-    "eslint-plugin-prettier": "^3.1.3",
+    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-jest": "^23.18.0",
+    "eslint-plugin-prettier": "^3.1.4",
     "husky": "^4.2.5",
-    "jest": "^26.0.1",
-    "jest-circus": "^26.0.1",
+    "jest": "^26.1.0",
+    "jest-circus": "^26.1.0",
     "prettier": "^2.0.5",
-    "ts-jest": "^26.1.0",
-    "typescript": "^3.9.3"
+    "ts-jest": "^26.1.3",
+    "typescript": "^3.9.7"
   },
   "husky": {
     "skipCI": true,

src/lists/bionic-php8.0-extensions

@@ -65,4 +65,5 @@ blackfire
 
 [Zend Modules]
 Zend OPcache
+Xdebug
 

src/lists/focal-php8.0-extensions

@@ -65,4 +65,4 @@ blackfire
 
 [Zend Modules]
 Zend OPcache
-
+Xdebug

src/lists/xenial-php8.0-extensions

@@ -65,4 +65,5 @@ blackfire
 
 [Zend Modules]
 Zend OPcache
+Xdebug
 

tsconfig.json

@@ -2,7 +2,7 @@
   "compilerOptions": {
     /* Basic Options */
     // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "target": "ES2019",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */