Merge pull request #528 from ergebnis/feature/synchronize

Enhancement: Synchronize with ergebnis/php-library-template

.gitattributes

@@ -1,4 +1,3 @@
-/.dependabot/                   export-ignore
 /.github/                       export-ignore
 /bin/                           export-ignore
 /phar/                          export-ignore

.github/CONTRIBUTING.md

@@ -19,7 +19,7 @@ We are using [`yamllint`](https://github.com/adrienverge/yamllint) to enforce co
 
 If you do not have `yamllint` installed yet, run
 
-```
+```sh
 $ brew install yamllint
 ```
 
@@ -29,7 +29,7 @@ We are using [`friendsofphp/php-cs-fixer`](https://github.com/FriendsOfPHP/PHP-C
 
 Run
 
-```
+```sh
 $ make coding-standards
 ```
 
@@ -41,7 +41,7 @@ We are using [`maglnet/composer-require-checker`](https://github.com/maglnet/Com
 
 Run
 
-```
+```sh
 $ make dependency-analysis
 ```
 
@@ -53,7 +53,7 @@ We are using [`phpstan/phpstan`](https://github.com/phpstan/phpstan) and [`vimeo
 
 Run
 
-```
+```sh
 $ make static-code-analysis
 ```
 
@@ -63,7 +63,7 @@ We are also using the baseline features of [`phpstan/phpstan`](https://medium.co
 
 Run
 
-```
+```sh
 $ make static-code-analysis-baseline
 ```
 
@@ -77,7 +77,7 @@ We are using [`phpunit/phpunit`](https://github.com/sebastianbergmann/phpunit) t
 
 Run
 
-```
+```sh
 $ make tests
 ```
 
@@ -87,7 +87,7 @@ to run all the tests.
 
 Run
 
-```
+```sh
 $ make
 ```
 
@@ -97,7 +97,7 @@ to enforce coding standards, run a static code analysis, and run tests!
 
 :bulb: Run
 
-```
+```sh
 $ make help
 ```
 

.github/actions/composer/composer/determine-cache-directory/action.yaml

@@ -0,0 +1,16 @@
+# https://docs.github.com/en/actions/creating-actions/creating-a-composite-run-steps-action
+# https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
+# https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-composite-run-steps-actions
+# https://getcomposer.org/doc/03-cli.md#composer-cache-dir
+
+name: "Determine composer cache directory"
+
+description: "Determines the composer cache directory and exports it as COMPOSER_CACHE_DIR environment variable"
+
+runs:
+  using: "composite"
+
+  steps:
+    - name: "Determine composer cache directory"
+      shell: "bash"
+      run: "echo \"::set-env name=COMPOSER_CACHE_DIR::$(composer config cache-dir)\""

.github/actions/composer/composer/install/action.yaml

@@ -0,0 +1,22 @@
+# https://docs.github.com/en/actions/creating-actions/creating-a-composite-run-steps-action
+# https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputs
+# https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs-for-composite-run-steps-actions
+
+name: "Install dependencies with composer"
+
+description: "Installs dependencies with composer"
+
+inputs:
+  dependencies:
+    description: "Which dependencies to install, one of \"lowest\", \"locked\", \"highest\""
+    required: true
+
+runs:
+  using: "composite"
+
+  steps:
+    - name: "Install ${{ inputs.dependencies }} dependencies with composer"
+      shell: "bash"
+      run: "${{ github.action_path }}/run.sh"
+      env:
+        COMPOSER_INSTALL_DEPENDENCIES: "${{ inputs.dependencies }}"

.github/actions/composer/composer/install/run.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+dependencies="${COMPOSER_INSTALL_DEPENDENCIES}"
+
+if [[ ${dependencies} == "lowest" ]]; then
+  composer update --no-interaction --no-progress --no-suggest --prefer-lowest
+
+  exit 0
+fi
+
+if [[ ${dependencies} == "locked" ]]; then
+  composer install --no-interaction --no-progress --no-suggest
+
+  exit 0
+fi
+
+if [[ ${dependencies} == "highest" ]]; then
+  composer update --no-interaction --no-progress --no-suggest
+
+  exit 0
+fi
+
+echo "::error::The value for the \"dependencies\" input needs to be one of \"lowest\", \"locked\"', \"highest\"' - got \"${dependencies}\" instead."
+
+exit 1

.github/dependabot.yml

@@ -1,4 +1,4 @@
-# https://help.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
 
 version: 2
 

.github/settings.yml

@@ -3,8 +3,8 @@
 branches:
   - name: "main"
 
-    # https://developer.github.com/v3/repos/branches/#remove-branch-protection
-    # https://developer.github.com/v3/repos/branches/#update-branch-protection
+    # https://docs.github.com/en/rest/reference/repos#delete-branch-protection
+    # https://docs.github.com/en/rest/reference/repos#update-branch-protection
 
     protection:
       enforce_admins: false
@@ -50,7 +50,7 @@ branches:
         strict: false
       restrictions:
 
-        # https://developer.github.com/v3/repos/branches/#parameters-1
+        # https://docs.github.com/en/rest/reference/repos#list-branches--parameters
 
         # Note: User, app, and team restrictions are only available for organization-owned repositories.
         # Set to null to disable when using this configuration for a repository on a personal account.
@@ -60,8 +60,8 @@ branches:
         users:
           - "ergebnis-bot"
 
-# https://developer.github.com/v3/issues/labels/#create-a-label
-# https://developer.github.com/v3/issues/labels/#update-a-label
+# https://docs.github.com/en/rest/reference/issues#create-a-label
+# https://docs.github.com/en/rest/reference/issues#update-a-label
 
 labels:
   - name: "bug"
@@ -92,7 +92,7 @@ labels:
     color: "eeeeee"
     description: ""
 
-# https://developer.github.com/v3/repos/#edit
+# https://docs.github.com/en/rest/reference/repos#update-a-repository
 
 repository:
   allow_merge_commit: true
@@ -110,6 +110,6 @@ repository:
   name: "composer-normalize"
   private: false
 
-  # https://developer.github.com/v3/repos/branches/#remove-branch-protection
+  # https://docs.github.com/en/rest/reference/repos#replace-all-repository-topics
 
   topics: "composer, composer-plugin, json, normalizer"