Merge branch 'v3' into patch-2

Author: ramsey

CONTRIBUTING.md

@@ -81,7 +81,7 @@ When you do begin working on your feature, here are some guidelines to consider:
 * **Submit one feature per pull request.** If you have multiple features you
   wish to submit, please break them into separate pull requests.
 * **Write good commit messages.** This project follows the
-  [Conventional Commits][] specification and uses Git hooks to ensure all
+  [Conventional Commits][conv-commit] specification and uses Git hooks to ensure all
   commits follow this standard. Running `composer install` will set up the Git
   hooks, so when you run `git commit`, you'll be prompted to create a commit
   using the Conventional Commits rules.
@@ -117,3 +117,4 @@ composer test
 [issues]: https://github.com/ramsey/composer-install/issues
 [pull requests]: https://github.com/ramsey/composer-install/pulls
 [gh-flow]: https://guides.github.com/introduction/flow/
+[conv-commit]: https://www.conventionalcommits.org/

README.md

@@ -85,6 +85,25 @@ For example:
     composer-options: "--ignore-platform-reqs --optimize-autoloader"
 ```
 
+#### composer-filename
+
+If you have a custom Composer filename, you may use `composer-filename` to change
+the filename Composer uses. For example, your Composer file could be
+`composer-gh-actions.json` or `composer-staging.json` instead of the default
+`composer.json`.
+
+You should specify the filename without the extension, since it will determine
+both the JSON and lock filenames to use. The default value is `"composer"`,
+which will use `composer.json` and `composer.lock` as the filenames.
+
+For example:
+
+```yaml
+- uses: "ramsey/composer-install@v3"
+  with:
+    custom-composer-filename: "composer-gh-actions"
+```
+
 #### working-directory
 
 The `working-directory` input parameter allows you to specify a different
@@ -120,6 +139,8 @@ For example:
 
 #### ignore-cache
 
+Normally, ramsey/composer-install preserves composer's cache between jobs
+so that subsequent identically-invoked jobs execute faster.
 If you have jobs for which you wish to completely ignore the caching step, you
 may use the `ignore-cache` input parameter. When present, ramsey/composer-install
 will neither read from nor write to the cache.
@@ -175,6 +196,17 @@ even more specific, you can specify a suffix to be added to the cache key via th
 > [!WARNING]
 > Specifying a `custom-cache-key` will take precedence over the `custom-cache-suffix`.
 
+
+#### require-lock-file
+
+By default, if no composer.lock file is found in the working directory
+ramsey/composer-install will invoke `composer update` regardless of the value of
+`dependency-versions`.
+
+If this is set to a value of `true`, ramsey/composer-install will fail in its
+execution if it does not find a lock file.
+
+
 ### Fork and private repositories
 
 Sometimes it's needed to use the `repositories` key in your `composer.json` to pull in forks, PRs with patches or private repositories. In this case, your GitHub Action may start failing with a `Could not authenticate against github.com` error message. To solve this, you need to use an authorized token; luckily [GHA provides you with one automatically at each run](https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication), you just need to set the `repository-projects` permission to `read`:

action.yml

@@ -39,6 +39,13 @@ inputs:
       Require lock file for install command.
     required: false
     default: "false"
+  composer-filename:
+    description: >-
+      The Composer filename to use, without the extension (e.g. `composer`,
+      `composer-gh-actions`, `composer-staging`). Please note: this is not a
+      path. If you need to specify a different path, use `working-directory`.
+    required: false
+    default: "composer"
 
 runs:
   using: "composite"
@@ -51,17 +58,17 @@ runs:
     - name: "Determine whether we should ignore caching"
       id: "should-cache"
       shell: "bash"
-      run: "${GITHUB_ACTION_PATH}/bin/should_cache.sh \"${{ inputs.ignore-cache }}\""
+      run: '${GITHUB_ACTION_PATH}/bin/should_cache.sh "${{ inputs.ignore-cache }}"'
 
     - name: "Determine Composer paths"
       id: "composer"
-      if: steps.should-cache.outputs.do-cache == 1
       shell: "bash"
       run: |
         ${GITHUB_ACTION_PATH}/bin/composer_paths.sh \
           "" \
           "${{ inputs.working-directory }}" \
-          "${{ steps.php.outputs.path }}"
+          "${{ steps.php.outputs.path }}" \
+          "${{ inputs.composer-filename }}"
 
     - name: "Determine cache key"
       id: "cache-key"
@@ -73,7 +80,7 @@ runs:
           "${{ steps.php.outputs.version }}" \
           "${{ inputs.dependency-versions }}" \
           "${{ inputs.composer-options }}" \
-          "${{ hashFiles('**/composer.json', '**/composer.lock') }}" \
+          "${{ hashFiles('**/${{ inputs.composer-filename }}.json', '**/${{ inputs.composer-filename }}.lock') }}" \
           "${{ inputs.custom-cache-key }}" \
           "${{ inputs.custom-cache-suffix }}" \
           "${{ inputs.working-directory }}"
@@ -97,4 +104,5 @@ runs:
           "${{ steps.php.outputs.path }}" \
           "${{ steps.composer.outputs.composer_command }}" \
           "${{ steps.composer.outputs.lock }}" \
-          "${{ inputs.require-lock-file }}"
+          "${{ inputs.require-lock-file }}" \
+          "${{ inputs.composer-filename }}" \

bin/composer_install.sh

@@ -7,6 +7,7 @@ php_path="${4:-$(which php)}"
 composer_path="${5:-$(which composer)}"
 composer_lock="${6:-}"
 require_lock_file="${7:-}"
+composer_filename="${8:-composer}"
 
 composer_command="update"
 composer_options=("--no-interaction" "--no-progress" "--ansi")
@@ -33,6 +34,10 @@ if [ -n "${working_directory}" ]; then
     composer_options+=("--working-dir" "${working_directory}")
 fi
 
+COMPOSER="${composer_filename}.json"
+export COMPOSER
+
 full_command="${php_path} ${composer_path} ${composer_command} ${composer_options[*]}"
 echo "::debug::Using the following Composer command: '${full_command}'"
+echo "::debug::The COMPOSER environment variable is '${COMPOSER}'"
 $full_command

bin/composer_paths.sh

@@ -3,31 +3,35 @@
 composer_path="${1:-$(which composer)}"
 working_directory="${2:-.}"
 php_path="${3:-$(which php)}"
+composer_filename="${4:-composer}"
 
 function test_composer {
     "${php_path}" "${composer_path}" --version > /dev/null 2>&1
 }
 
 function validate_composer {
-    "${php_path}" "${composer_path}" validate --no-check-publish --no-check-lock --working-dir "${working_directory}" > /dev/null 2>&1
+    "${php_path}" "${composer_path}" validate --no-check-publish --no-check-lock --working-dir "${working_directory}"  > /dev/null 2>&1
 }
 
 if ! test_composer; then
     echo "::error title=Composer Not Found::Unable to find Composer at '${composer_path}'"
     exit 1
 fi
 
-composer_json="composer.json"
-composer_lock="composer.lock"
+composer_json="${composer_filename}.json"
+composer_lock="${composer_filename}.lock"
+
+COMPOSER="${composer_json}"
+export COMPOSER
 
 if [ -n "${working_directory}" ]; then
     if [ ! -d "${working_directory}" ]; then
         echo "::error title=Working Directory Not Found::Unable to find working directory at '${working_directory}'"
         exit 1
     fi
 
-    composer_json="${working_directory}/composer.json"
-    composer_lock="${working_directory}/composer.lock"
+    composer_json="${working_directory}/${composer_json}"
+    composer_lock="${working_directory}/${composer_lock}"
 fi
 
 if [ ! -f "${composer_json}" ]; then
@@ -45,14 +49,15 @@ if [ ! -f "${composer_lock}" ]; then
     composer_lock=""
 fi
 
-composer_version="$($composer_path --version)"
+composer_version="$($composer_path --version 2>/dev/null)"
 cache_dir="$($composer_path --working-dir="${working_directory}" config cache-dir)"
 
 echo "::debug::Composer path is '${composer_path}'"
 echo "::debug::${composer_version}"
 echo "::debug::Composer cache directory found at '${cache_dir}'"
 echo "::debug::File composer.json found at '${composer_json}'"
 echo "::debug::File composer.lock path computed as '${composer_lock}'"
+echo "::debug::The COMPOSER environment variable is '${COMPOSER}'"
 {
     echo "composer_command=${composer_path}"
     echo "cache-dir=${cache_dir}"

tests/composer_install.bats

@@ -24,9 +24,11 @@ teardown() {
         '' \
         '' \
         '' \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer install --no-interaction --no-progress --ansi'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Verifying lock file contents can be installed on current platform'
     assert_line --partial 'Generating autoload files'
@@ -43,9 +45,11 @@ teardown() {
         '' \
         '' \
         '' \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer update --no-interaction --no-progress --ansi --prefer-lowest --prefer-stable'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Updating dependencies'
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Generating autoload files'
@@ -62,9 +66,11 @@ teardown() {
         '' \
         '' \
         '' \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer update --no-interaction --no-progress --ansi'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Updating dependencies'
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Generating autoload files'
@@ -81,9 +87,11 @@ teardown() {
         '' \
         '' \
         '' \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer install --no-interaction --no-progress --ansi'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Verifying lock file contents can be installed on current platform'
     assert_line --partial 'Generating autoload files'
@@ -100,9 +108,11 @@ teardown() {
         '' \
         '' \
         '' \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer install --no-interaction --no-progress --ansi'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Verifying lock file contents can be installed on current platform'
     assert_line --partial 'Generating autoload files'
@@ -119,9 +129,11 @@ teardown() {
         '' \
         '' \
         '' \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer install --no-interaction --no-progress --ansi --ignore-platform-reqs --optimize-autoloader'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Verifying lock file contents can be installed on current platform'
     assert_line --partial 'Generating optimized autoload files'
@@ -138,9 +150,11 @@ teardown() {
         '' \
         '' \
         '' \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer update --no-interaction --no-progress --ansi --prefer-lowest --prefer-stable --ignore-platform-reqs --optimize-autoloader'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Updating dependencies'
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Generating optimized autoload files'
@@ -157,9 +171,11 @@ teardown() {
         '' \
         '' \
         '' \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer update --no-interaction --no-progress --ansi --ignore-platform-reqs --optimize-autoloader'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Updating dependencies'
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Generating optimized autoload files'
@@ -176,9 +192,11 @@ teardown() {
         '' \
         '' \
         '' \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer install --no-interaction --no-progress --ansi --ignore-platform-reqs --optimize-autoloader'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Verifying lock file contents can be installed on current platform'
     assert_line --partial 'Generating optimized autoload files'
@@ -195,9 +213,11 @@ teardown() {
         '' \
         '' \
         "$PROJECT_ROOT/tests/fixtures/composer.phar" \
-        'composer.lock'
+        'composer.lock' \
+        ''
 
     assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer\.phar install --no-interaction --no-progress --ansi'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer.json'"
     assert_line --partial 'Installing dependencies from lock file (including require-dev)'
     assert_line --partial 'Verifying lock file contents can be installed on current platform'
     assert_line --partial 'Generating autoload files'

tests/composer_install_with_custom_composer_file.bats

@@ -0,0 +1,62 @@
+#!/usr/bin/env bats
+
+setup() {
+    load 'test_helper/common_setup'
+    _common_setup
+
+    cd "$PROJECT_ROOT/tests/fixtures/custom-composer" || exit 1
+}
+
+teardown() {
+    if [ -d vendor ]; then
+        rm -rf vendor
+    fi
+
+    git restore composer-gh-actions.lock
+
+    cd ../.. || exit 1
+}
+
+@test 'installs dependencies using custom composer file and lock file' {
+    run -0 composer_install.sh \
+        '' \
+        '' \
+        '' \
+        '' \
+        '' \
+        'composer-gh-actions.lock' \
+        '' \
+        'composer-gh-actions'
+
+    assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer install --no-interaction --no-progress --ansi'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer-gh-actions.json'"
+    assert_line --partial 'Installing dependencies from lock file (including require-dev)'
+    assert_line --partial 'Verifying lock file contents can be installed on current platform'
+    assert_line --partial 'Generating autoload files'
+
+    refute_line --partial 'Updating dependencies'
+
+    assert_dir_exists "$PROJECT_ROOT/tests/fixtures/custom-composer/vendor"
+}
+
+@test 'installs dependencies using custom composer file without lock file' {
+    run -0 composer_install.sh \
+        '' \
+        '' \
+        '' \
+        '' \
+        '' \
+        '' \
+        '' \
+        'composer-gh-actions'
+
+    assert_line --index 0 --regexp "^::debug::Using the following Composer command: '.*/php .*/composer update --no-interaction --no-progress --ansi'$"
+    assert_line "::debug::The COMPOSER environment variable is 'composer-gh-actions.json'"
+    assert_line --partial 'Updating dependencies'
+    assert_line --partial 'Installing dependencies from lock file (including require-dev)'
+    assert_line --partial 'Generating autoload files'
+
+    refute_line --partial 'Verifying lock file contents can be installed on current platform'
+
+    assert_dir_exists "$PROJECT_ROOT/tests/fixtures/custom-composer/vendor"
+}