Skip to content

Commit

Permalink
docs: update readme for v6
Browse files Browse the repository at this point in the history
  • Loading branch information
g105b committed Jun 7, 2021
1 parent 000a9d1 commit c115e89
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,21 @@ jobs:

steps:
- uses: actions/checkout@v2
- uses: php-actions/composer@v5
- uses: php-actions/composer@v6
# ... then your own project steps ...
```

### Version numbers

This action is released with semantic version numbers, but also tagged so the latest major release's tag always points to the latest release within the matching major version.

Please feel free to use `uses: php-actions/composer@v6` to always run the latest version of v6, or `uses: php-actions/[email protected]` to specify the exact release.


Running custom commands
-----------------------

By default, adding `- uses: php-actions/composer@v5` into your workflow will run `composer install`, as `install` is the default command name. The install command will be provided with a default set of arguments (see below).
By default, adding `- uses: php-actions/composer@v6` into your workflow will run `composer install`, as `install` is the default command name. The install command will be provided with a default set of arguments (see below).

You can issue custom commands by passing a `command` input, like so:

Expand All @@ -43,7 +50,7 @@ jobs:
...

- name: Install dependencies
uses: php-actions/composer@v5
uses: php-actions/composer@v6
with:
command: your-command-here
```
Expand Down Expand Up @@ -74,7 +81,7 @@ jobs:
...
- name: Install dependencies
uses: php-actions/composer@v5
uses: php-actions/composer@v6
with:
dev: no
args: --profile --ignore-platform-reqs
Expand All @@ -98,7 +105,7 @@ jobs:
...
- name: Install dependencies
uses: php-actions/composer@v5
uses: php-actions/composer@v6
with:
php_version: 7.1
version: 1
Expand All @@ -119,7 +126,7 @@ jobs:
...
- name: Install dependencies
uses: php-actions/composer@v5
uses: php-actions/composer@v6
with:
php_version: 7.4
php_extensions: redis exif
Expand Down Expand Up @@ -151,7 +158,7 @@ jobs:
path: /tmp/composer-cache
key: ${{ runner.os }}-${{ hashFiles('**/composer.lock') }}
- uses: php-actions/composer@v5
- uses: php-actions/composer@v6
...
```
Expand All @@ -174,7 +181,7 @@ jobs:
...
- name: Install dependencies
uses: php-actions/composer@v5
uses: php-actions/composer@v6
with:
ssh_key: ${{ secrets.ssh_key }}
ssh_key_pub: ${{ secrets.ssh_key_pub }}
Expand Down Expand Up @@ -213,7 +220,7 @@ jobs:
run: echo '${{ secrets.COMPOSER_AUTH_JSON }}' > $GITHUB_WORKSPACE/auth.json
- name: Install dependencies
uses: php-actions/composer@v5
uses: php-actions/composer@v6
```

4) Now, any connections Composer makes to Github.com will use your HTTP basic auth credentials, which is essentially the same as being logged in as you, so your private repositories will now be available to Composer.
Expand Down

0 comments on commit c115e89

Please sign in to comment.