https://github.com/yakubique/github-releases
Get list of GitHub releases for repository
https://github.com/yakubique/github-releases
github github-actions
Last synced: about 2 months ago
JSON representation
Get list of GitHub releases for repository
- Host: GitHub
- URL: https://github.com/yakubique/github-releases
- Owner: yakubique
- License: mit
- Created: 2024-01-15T05:49:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-27T12:30:53.000Z (over 2 years ago)
- Last Synced: 2025-01-25T14:25:26.157Z (over 1 year ago)
- Topics: github, github-actions
- Language: TypeScript
- Homepage:
- Size: 184 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# github-releases
Get list of GitHub releases for repository
[](https://github.com/yakubique/github-releases/actions/workflows/test-myself.yaml)
## Usage
For live examples, please see [actions](https://github.com/yakubique/github-releases/actions/workflows/test-myself.yaml)
```yaml
uses: yakubique/github-releases@v1.2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
repository: yakubique/orogene
```
## With pre-releases
```yaml
uses: yakubique/github-releases@v1.2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
repository: yakubique/orogene
pre: 'true'
```
## Sort versions
```yaml
uses: yakubique/github-releases@v1.2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
repository: yakubique/orogene
sort: 'desc'
```
## Use output
```yaml
steps:
- uses: yakubique/github-releases@v1.2
id: get_releases
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
repository: yakubique/orogene
- run: |
echo "${{ steps.get_releases.outputs.releases }}"
```
## Inputs
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|------------|--------|----------|---------|-------------------------------------------------------------------------|
| debug | string | false | | Be verbal |
| details | string | false | | Add publication date, name and prerelease
status to return values |
| pre | string | false | | Include the pre-releases |
| repository | string | true | | Repository to get releases from (example: "yakubique/github-releases") |
| sort | string | false | `"ASC"` | Sort releases by publication date ["ASC",
"DESC"] (default :"ASC") |
### About `details`
_Optional_ Add publication date, name and prerelease status to return values (_default_: `'false'`)
If `false` (_default_):
```json
{
"releases": [
"v0.3.26",
"v0.3.22",
"v0.3.23",
"v0.3.25",
"v0.3.31",
"v0.3.34"
]
}
```
If `true`:
```json
{
"releases": [
{
"name": "v0.3.26",
"tag_name": "v0.3.26",
"prerelease": false,
"published_at": "2023-08-07T09:43:28Z"
},
{
"name": "v0.3.22",
"tag_name": "v0.3.22",
"prerelease": false,
"published_at": "2023-11-12T10:58:00Z"
},
{
"name": "v0.3.23",
"tag_name": "v0.3.23",
"prerelease": false,
"published_at": "2023-11-12T10:59:27Z"
},
{
"name": "v0.3.25",
"tag_name": "v0.3.25",
"prerelease": false,
"published_at": "2023-11-12T11:01:20Z"
},
{
"name": "v0.3.31",
"tag_name": "v0.3.31",
"prerelease": false,
"published_at": "2023-11-12T11:17:17Z"
},
{
"name": "v0.3.34",
"tag_name": "v0.3.34",
"prerelease": false,
"published_at": "2023-11-12T11:21:59Z"
}
]
}
```
## Outputs
| OUTPUT | TYPE | DESCRIPTION |
|----------|--------|-----------------------|
| releases | string | JSON list of releases |
----
[](https://ko-fi.com/S6S1UZ9P7)