github-releases

Get list of GitHub releases for repository

Usage

For live examples, please see actions

uses: yakubique/github-releases@v1.2
env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
  repository: yakubique/orogene

With pre-releases

uses: yakubique/github-releases@v1.2
env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
  repository: yakubique/orogene
  pre: 'true'

Sort versions

uses: yakubique/github-releases@v1.2
env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
  repository: yakubique/orogene
  sort: 'desc'

Use output

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):

{
  "releases": [
    "v0.3.26",
    "v0.3.22",
    "v0.3.23",
    "v0.3.25",
    "v0.3.31",
    "v0.3.34"
  ]
}

If true:

{
  "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

---