mirror of https://code.forgejo.org/actions/forgejo-release.git synced 2024-11-14 21:46:33 +02:00

benniekiss a5aa633273 Support downloading the latest release of a repo (#16 )

This PR adds the functionality to download the latest release from a repo. The API provides an endpoint to do so, so an option has been added to the action.

This closes #12

Co-authored-by: benniekiss <bgmt@mail.bbalm.me>
Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/16
Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org>
Co-authored-by: benniekiss <benniekiss@noreply.code.forgejo.org>
Co-committed-by: benniekiss <benniekiss@noreply.code.forgejo.org>

2024-07-08 18:49:13 +00:00

2.4 KiB

Raw Blame History

forgejo-release

Description

Upload or download the assets of a release to a Forgejo instance.

Inputs

name	description	required	default
`url`	URL of the Forgejo instance	`false`	`""`
`repo`	owner/project relative to the URL	`false`	`""`
`tag`	Tag of the release	`false`	`""`
`sha`	SHA of the release	`false`	`""`
`token`	Forgejo application token	`true`	`""`
`release-dir`	Directory in whichs release assets are uploaded or downloaded	`true`	`""`
`release-notes`	Release notes	`false`	`""`
`direction`	Can either be download or upload	`true`	`""`
`gpg-private-key`	GPG Private Key to sign the release artifacts	`false`	`""`
`gpg-passphrase`	Passphrase of the GPG Private Key	`false`	`""`
`download-retry`	Number of times to retry if the release is not ready (default 1)	`false`	`""`
`download-latest`	Download the latest release	`false`	`false`
`verbose`	Increase the verbosity level	`false`	`false`
`override`	Override an existing release by the same {tag}	`false`	`false`
`prerelease`	Mark Release as Pre-Release	`false`	`false`

Example

Upload

on: [tag]
jobs:
  upload-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/forgejo-release@v1
        with:
	        direction: upload
	        url: https://code.forgejo.org
          release-dir: dist/release
          release-notes: "MY RELEASE NOTES"

Download

Example downloading the forgejo release v1.21.4-0 into the working directory:

on: [tag]
jobs:
  download-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/forgejo-release@v1
        with:
	        direction: download
	        url: https://code.forgejo.org
          repo: forgejo/forgejo
          tag: v1.21.4-0
          release-dir: ./  # by default, files are downloaded into dist/release

Update the README

With https://github.com/npalm/action-docs action-docs --update-readme

2.4 KiB Raw Blame History