Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sxbrsky committed Jun 18, 2024
1 parent 48ca83f commit 3539ebd
Showing 1 changed file with 56 additions and 2 deletions.
58 changes: 56 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,65 @@
# Latest PHP Releases Action

A Github Action to fetch a list of active PHP releases from [php.net](https://php.net).
A GitHub Action to fetch a list of active PHP releases from [php.net](https://php.net).

## Outputs

### `releases`

The list of latest releases, as a list of objects (`object[]`).

```json
[
{
"version": "8.3.8",
"sources": [
{
"filename": "php-8.3.8.tar.gz",
"name": "PHP 8.3.8 (tar.gz)",
"sha256": "0ebed9f1471871cf131e504629f3947f2acd38a655cc31b036f99efd0e3dbdeb",
"date": "06 Jun 2024"
},
{
"filename": "php-8.3.8.tar.bz2",
"name": "PHP 8.3.8 (tar.bz2)",
"sha256": "f4a6cb005ae117aba86c2044932cf563899a2e977ac09781aa74b2161ddc563b",
"date": "06 Jun 2024"
},
{
"filename": "php-8.3.8.tar.xz",
"name": "PHP 8.3.8 (tar.xz)",
"sha256": "aea358b56186f943c2bbd350c9005b9359133d47e954cfc561385319ae5bb8d7",
"date": "06 Jun 2024"
}
]
}
]
```

## Example usage

```yaml
name: PHP Latest Releases

on: pull_request

jobs:
latest-releases:
runs-on: ubuntu-latest
outputs:
releases: ${{ steps.get-latest-releases.outputs.releases }}
steps:
- uses: nulxrd/latest-php-releases-action@v1
id: get-latest-releases

test:
needs: ['latest-releases']
runs-on: ubuntu-latest
strategy:
matrix:
releases: ${{ fromJson(needs.latest-releases.outputs.releases)}}
```
## License
This project is licensed under the [MIT License](LICENSE).
This project is licensed under the [MIT License](LICENSE).

0 comments on commit 3539ebd

Please sign in to comment.