Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kawax/composer-workflow


https://github.com/kawax/composer-workflow

Last synced: 21 days ago
JSON representation

Awesome Lists containing this project

README

        

# composer update workflow (reusable)

Run `composer update` and create pull request.

## Usage

### Create Personal access tokens (classic)
Then, set a token in the repository's secrets as `ACTION_TOKEN`

`GITHUB_TOKEN` can't trigger other actions. If you want to run tests after pull request, you need a token.

### Create `.github/workflows/composer-update.yml`

```yaml
name: composer update

on:
schedule:
- cron: '0 0 * * *' #UTC

jobs:
composer:
uses: kawax/composer-workflow/.github/workflows/update.yml@v1
secrets:
token: ${{ secrets.ACTION_TOKEN }}
```

## Inputs
| name | description | default |
|----------------|----------------------------------------------|---------------------------------------------------------|
| php | php version (same as setup-php) | 'latest' |
| extensions | php extensions (same as setup-php) | mbstring |
| git-name | git name | `github-actions[bot]` |
| git-email | git email | `41898282+github-actions[bot]@users.noreply.github.com` |
| composer-path | working directory | `./` |
| branch | git branch (Always works on a single branch) | composer-update |
| title | Pull request title | composer update |
| commit-message | commit message | composer update |

```yaml
jobs:
composer:
uses: kawax/composer-workflow/.github/workflows/update.yml@v1
secrets:
token: ${{ secrets.ACTION_TOKEN }}
with:
php: 8.4
extensions: mbstring
git-name: github-actions[bot]
git-email: 41898282+github-actions[bot]@users.noreply.github.com
composer-path: ./composer
branch: composer-update
title: composer update
commit-message: composer update
```

## LICENCE
MIT