mirror of https://code.forgejo.org/actions/forgejo-release.git synced 2025-04-21 08:28:46 +00:00

/ integration (push) Has been cancelled

Details

feat: add default token and document default values (#44 )

This PR adds `${{ secrets.GITHUB_TOKEN }}` as the default value for the token and documents all default values in the readme.
Fixes #43

Co-authored-by: Dorian Zedler <dorian@itsblue.de>
Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/44
Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org>
Co-authored-by: dorianim <dorianim@noreply.code.forgejo.org>
Co-committed-by: dorianim <dorianim@noreply.code.forgejo.org>

2025-04-07 06:35:43 +00:00

3.2 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`	`${{ env.GITHUB_SERVER_URL }}`
`repo`	owner/project relative to the URL	`false`	`${{ github.repository }}`
`tag`	Tag of the release	`false`	`${{ github.ref_name }}`
`title`	Title of the release (defaults to tag)	`false`	`""`
`sha`	SHA of the release	`false`	`${{ github.sha }}`
`token`	Forgejo application token	`false`	`${{ secrets.GITHUB_TOKEN }}`
`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`
`release-notes-assistant`	Generate release notes with Release Notes Assistant	`false`	`false`
`hide-archive-link`	Hide the archive links	`false`	`false`

Examples

Upload

Upload the release located in release-dir to the release section of a repository (url and repo):

on: [tag]
jobs:
  upload-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/forgejo-release@v2
        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@v2
        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

Real world example

This action is used to publish the release notes assistant assets.

Update the `input` section of the README

Using action-docs:

# Edit the action.yml file and run:
action-docs --update-readme

3.2 KiB Raw Blame History