first commit

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at contact@shivammathur.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing to setup-php
+
+## Welcome!
+
+We look forward to your contributions! Here are some examples how you can contribute:
+
+* [Ask any questions you may have](https://github.com/shivammathur/setup-php/discussions/new?category=Q-A-Help)
+* [Report a bug](https://github.com/shivammathur/setup-php/issues/new?labels=type/bug&template=bug.md)
+* [Propose a new feature](https://github.com/shivammathur/setup-php/issues/new?labels=enhancement&template=feature.md)
+* [Send a pull request](https://github.com/shivammathur/setup-php/pulls)
+
+## Contributor Code of Conduct
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## Getting Started
+
+To get started fork `setup-php` and clone it using git:
+
+```bash
+git clone https://github.com/<your-username>/setup-php.git
+
+cd setup-php
+```
+
+If you are using `Windows` configure `git` to handle line endings.
+
+```cmd
+git config --local core.autocrlf true
+```
+
+Install `setup-php` dependencies using [npm](https://www.npmjs.com/):
+
+```bash
+npm install
+```
+
+## Workflow to create Pull Requests
+
+* Fork the `setup-php` project and clone it.
+* Create a new branch from the develop branch.
+* Make your bug fix or feature addition.
+* Add tests for it, so we don't break it in a future version unintentionally.
+* Ensure the test suite passes and the code complies with our coding guidelines (see below).
+* Send a pull request to the develop branch with all the details.
+* If possible, create a GitHub Actions workflow with an integration test for the change in a demo repository and link it in your pull request.
+
+Please make sure that you have [set up your user name and email address](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) for use with Git. Strings such as `silly nick name <root@localhost>` look really stupid in the commit history of a project.
+
+Due to time constraints, you may not always get a quick response. Please do not take delays personally and feel free to remind.
+
+## Coding Guidelines
+
+This project comes with `.prettierrc.json` and `eslintrc.json` configuration files. Please run the following commands to fix and verify the code quality.
+
+```bash
+npm run format
+npm run lint
+```
+
+### Running the test suite
+
+After following the steps shown above, The `setup-php` tests in the `__tests__` directory can be run using this command:
+
+```bash
+npm test
+```
+
+### Creating a release
+
+Creating a release means compiling all the TypeScript code to a single file which `setup-php` can run. Run this, before you push your changes.
+
+```bash
+npm run build
+npm run release
+```
+
+### Reporting issues and discussions
+
+For questions or support, we prefer GitHub Discussions. For any bugs or new features you can create an issue using the appropriate template:
+
+* [Discussions](https://github.com/shivammathur/setup-php/discussions)
+* [Issues](https://github.com/shivammathur/setup-php/issues)

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: shivammathur

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Nice, you found a bug!
+title: ''
+labels: 'bug'
+assignees: 'shivammathur'
+
+---
+
+**Describe the bug**
+<!-- Please describe the bug concisely. -->
+
+**Version**
+- [ ] I have checked releases, and the bug exists in the latest patch version of `v1` or `v2`.
+- [ ] `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 relevant steps of your workflow `.yml` file. -->
+
+**Expected behavior**
+<!-- A clear and concise description of what you expected to happen. -->
+
+**Screenshots/Logs**
+<!-- If applicable, add screenshots or logs to help explain your problem. -->
+
+**Additional context**
+<!-- 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.md

@@ -0,0 +1,26 @@
+---
+name: Feature request
+about: Suggest a new feature
+title: ''
+labels: 'enhancement'
+assignees: 'shivammathur'
+
+---
+
+**Describe the feature**
+<!-- Please describe concisely the feature you want to add. -->
+
+**Version**
+- [ ] I have checked releases, and the feature is missing in the latest patch version of `v2`.
+
+**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. -->
+
+**Are you willing to submit a PR?**
+<!-- We accept pull requests targeting the develop branch. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+---
+name: 🐞 Bug Fix, ⚙ Improvement or 🎉 New Feature
+about: You found a bug, want to improve something or add a new feature
+labels: bug or enhancement
+
+---
+
+## A Pull Request should be associated with a Discussion.
+
+> If you're fixing a bug, adding a new feature or improving something please provide the details in discussions,
+> so that the development can be pointed in the intended direction.
+
+Related discussion: <!-- Please link the related discussion -->
+
+> Further notes in [Contribution Guidelines](.github/CONTRIBUTING.md)
+> Thank you for your contribution.
+
+### 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 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 YAML and link).
+
+<!--
+- Please target the develop branch when submitting the pull request.
+-->

.github/SECURITY.md

@@ -0,0 +1,24 @@
+# Security Policy
+
+## Supported Versions
+
+The latest patch versions of `v1` and `v2` releases of this project are supported for security updates.
+
+## Supported PHP Versions
+
+This security policy only applies to the latest patches of the following PHP versions.
+
+| Version | Supported          |
+|---------|--------------------|
+| 8.1     | :white_check_mark: |
+| 8.2     | :white_check_mark: |
+| 8.3     | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you have found any issues that might have security implications in the versions supported, please send a report privately to [contact@shivammathur.com](mailto:contact@shivammathur.com).
+Do not report security reports publicly.
+
+## Tidelift
+
+If you use this GitHub Action through a Tidelift subscription, please refer to [https://tidelift.com/security](https://tidelift.com/security).

.github/codeql/codeql-configuration.yml

@@ -0,0 +1,4 @@
+name : CodeQL Configuration
+
+paths:
+  - './src'

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  target-branch: "develop"
+  schedule:
+      interval: "weekly"

.github/workflows/codeql.yml

@@ -0,0 +1,32 @@
+name: CodeQL Workflow
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 15 * * 6'
+permissions:
+  contents: read
+
+jobs:
+  codeql:
+    permissions:
+      actions: read  # for github/codeql-action/init to get workflow details
+      contents: read  # for actions/checkout to fetch code
+      security-events: write  # for github/codeql-action/autobuild to send a status report
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          config-file: ./.github/codeql/codeql-configuration.yml
+          languages: javascript
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/docs.yml

@@ -0,0 +1,92 @@
+name: Docs workflow
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 15 * * 6'
+permissions:
+  contents: read
+
+jobs:
+  create:
+    permissions:
+      contents: none
+    name: Create
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      fail-fast: false
+      matrix:
+        operating-system: [ubuntu-22.04, ubuntu-20.04, windows-2022, macos-12]
+        php-versions: ['5.3', '5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+      - name: Create for Linux and macOS
+        env:
+          file: php${{ matrix.php-versions }}-${{ matrix.operating-system }}.md
+          version: ${{ matrix.php-versions }}
+        if: matrix.operating-system != 'windows-2022'
+        run: |
+          echo "## PHP $version" >> "$file"
+          printf "\n" >> "$file"
+          echo "\`\`\`" >> "$file"
+          php -m >> "$file"
+          echo "\`\`\`" >> "$file"
+          printf "\n" >> "$file"
+      - name: Create for Windows
+        env:
+          file: php${{ matrix.php-versions }}-${{ matrix.operating-system }}.md
+          version: ${{ matrix.php-versions }}
+        if: matrix.operating-system == 'windows-2022'
+        run: |
+          Write-Output "## PHP ${{ matrix.php-versions }}`n" | Out-File -FilePath "$env:file"
+          Write-Output "``````" | Out-File -FilePath "$env:file" -Append
+          php -m | Out-File -FilePath "$env:file" -Append
+          Write-Output "```````n" | Out-File -FilePath "$env:file" -Append
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: lists
+          path: php${{ matrix.php-versions }}-${{ matrix.operating-system }}.md
+  update:
+    permissions:
+      contents: write  # for Git to git push
+    name: Update
+    needs: create
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.repository }}.wiki
+      - name: Download artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: ${{ github.workspace }}
+      - name: Configure Git
+        run : |
+          git config --local user.email "${{ secrets.email }}"
+          git config --local user.name "${{ github.repository_owner }}"
+      - name: Combine
+        run: |
+          for os in ubuntu-22.04 ubuntu-20.04 windows-2022 windows-2019 macos-11 macos-12 macos-13; do
+            echo "These are extensions which are loaded by default on the following PHP versions. More extensions which are available as packages and available on pecl are supported by setup-php. Refer to [php extension support](https://github.com/shivammathur/setup-php#heavy_plus_sign-php-extension-support) for more details." > Php-extensions-loaded-on-"$os".md
+            for version in 5.3 5.4 5.5 5.6 7.0 7.1 7.2 7.3 7.4 8.0 8.1 8.2 8.3 8.4; do
+              if [[ "$os" = "macos-11" || "$os" = "macos-13" ]]; then
+                cat lists/php"$version"-macos-12.md >> Php-extensions-loaded-on-"$os".md
+              elif [ "$os" = "windows-2019" ]; then
+                cat lists/php"$version"-windows-2022.md >> Php-extensions-loaded-on-"$os".md
+              else
+                cat lists/php"$version"-"$os".md >> Php-extensions-loaded-on-"$os".md
+              fi
+            done
+          done
+          rm -rf ./lists
+      - name: Update
+        run: |
+          if [ "$(git status --porcelain=v1 2>/dev/null | wc -l)" != "0" ]; then
+            git add .
+            git commit -m "Update PHP extensions on wiki - $(date +'%d-%m-%y')"
+            git push -f https://${{ github.repository_owner }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git master || true
+          fi

.github/workflows/node.yml

@@ -0,0 +1,63 @@
+name: Node workflow
+on:
+  pull_request:
+    branches:
+      - master
+      - develop
+      - verbose
+    paths-ignore:
+      - '**.md'
+      - 'examples/**'
+  push:
+    branches:
+      - master
+      - develop
+      - verbose
+    paths-ignore:
+      - '**.md'
+      - 'examples/**'
+permissions:
+  contents: read
+
+jobs:
+  run:
+    name: Run
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      fail-fast: false
+      matrix:
+        operating-system: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+
+      - name: Setup Node.js 16.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 16.x
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Prettier Format Check
+        run: npm run format-check
+
+      - name: ESLint Check
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test
+
+      - name: Run npm audit
+        run: npm audit
+
+      - name: Send Coverage
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage/lcov.info
+          name: github-actions-codecov-${{ matrix.operating-system }}
+          fail_ci_if_error: false
+          verbose: true

.github/workflows/php.yml

@@ -0,0 +1,93 @@
+name: Main workflow
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - master
+      - develop
+      - verbose
+    paths-ignore:
+      - '**.md'
+      - 'examples/**'
+  push:
+    branches:
+      - master
+      - develop
+      - verbose
+    paths-ignore:
+      - '**.md'
+      - 'examples/**'
+permissions:
+  contents: read
+env:
+  default-php-version: '8.2'
+jobs:
+  run:
+    name: Run
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      fail-fast: false
+      matrix:
+        operating-system: [ubuntu-22.04, ubuntu-20.04, windows-2019, macos-latest]
+        php-versions: ['5.3', '5.4', '5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+        include:
+          - operating-system: ubuntu-22.04
+            php-versions: ''
+            php-version-file: 'php-version-file'
+    env:
+      extensions: xml, opcache, xdebug, pcov, gd
+      key: cache-v5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup cache environment
+        id: cache-env
+        uses: shivammathur/cache-extensions@develop
+        with:
+          php-version: ${{ matrix.php-versions || env.default-php-version }}
+          extensions: ${{ env.extensions }}
+          key: ${{ env.key }}
+
+      - name: Cache extensions
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.cache-env.outputs.dir }}
+          key: ${{ steps.cache-env.outputs.key }}
+          restore-keys: ${{ steps.cache-env.outputs.key }}
+
+      - name: Stage php-version-file
+        if: ${{ matrix.php-version-file == 'php-version-file' }}
+        run: |
+          echo ${{ env.default-php-version }} > php-version-file
+
+      - name: Setup PHP with extensions and custom config
+        run: node dist/index.js
+        env:
+          php-version: ${{ matrix.php-versions }}
+          php-version-file: ${{ matrix.php-version-file }}
+          extensions: ${{ env.extensions }}
+          ini-values: post_max_size=256M, short_open_tag=On, date.timezone=Asia/Kolkata
+
+      - name: Testing PHP version
+        run: |
+          php -v
+          php -r "if(strpos(phpversion(), '${{ matrix.php-versions || env.default-php-version }}') === false) {throw new Exception('Wrong PHP version Installed');}"
+
+      - name: Testing Composer version
+        run: |
+          composer -V
+          php -r "if(strpos(@exec('composer -V'), 'Composer version') === false) {throw new Exception('Composer not found');}"
+      - name: Testing Extensions
+        run: |
+          php -m
+          php -r "if(! extension_loaded('gd')) {throw new Exception('gd not found');}"
+          php -r "if(! extension_loaded('xml')) {throw new Exception('xml not found');}"
+          php -r "if(! extension_loaded('Xdebug')) {throw new Exception('Xdebug not found');}"
+          php -r "if(phpversion()>=7.1 && ! extension_loaded('pcov')) {throw new Exception('PCOV not found');}"
+      - name: Testing ini values
+        run: |
+          php -r "if(ini_get('memory_limit')!='-1') {throw new Exception('memory_limit not disabled');}"
+          php -r "if(ini_get('post_max_size')!='256M') {throw new Exception('post_max_size not added');}"
+          php -r "if(ini_get('short_open_tag')!=1) {throw new Exception('short_open_tag not added');}"
+          php -r "if(ini_get('date.timezone')!='Asia/Kolkata') {throw new Exception('date.timezone not added');}"

.github/workflows/publish.yml

@@ -0,0 +1,62 @@
+name: Publish Package
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+    inputs:
+      skip:
+        description: Skip release to repository
+        required: false
+      tag:
+        description: Tag name
+        required: true
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout release
+        if: github.event_name != 'workflow_dispatch'
+        uses: actions/checkout@v4
+
+      - name: Checkout tag
+        uses: actions/checkout@v4
+        if: github.event_name == 'workflow_dispatch'
+        with:
+          ref: ${{ github.event.inputs.tag }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '16.x'
+          registry-url: https://registry.npmjs.org
+
+      - name: Install dependencies and add lib
+        run: |
+          npm install
+          npm run build
+          sed -i -e '/lib\//d' .gitignore
+
+      - name: Publish to NPM
+        if: "!contains(github.event.inputs.skip, 'skip-npm')"
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Change to GitHub Packages registry
+        uses: actions/setup-node@v4
+        with:
+          registry-url: https://npm.pkg.github.com
+          scope: '@shivammathur'
+
+      - name: Patch package.json
+        run: |
+          sed -i 's#"name": "#"name": "@shivammathur/#' package.json
+
+      - name: Publish to GitHub Packages
+        if: "!contains(github.event.inputs.skip, 'skip-github-packages')"
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}