mirror of https://code.forgejo.org/actions/forgejo-release synced 2024-11-21 17:50:40 +00:00

No description

Find a file

Michael Kriese 799c07b6e7 Some checks failed / integration (push) Has been cancelled Details Merge pull request 'Configure Renovate' (#31 ) from renovate/configure into main Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/31 Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org> Reviewed-by: Michael Kriese <michael.kriese@gmx.de>		2024-11-20 15:18:27 +00:00
.forgejo/workflows	Merge pull request 'feat: enable release-notes-assistant' (#28 ) from natct/forgejo-release:use_rna into main	2024-11-18 15:09:23 +00:00
testdata	feat(ci): add test for `rna`	2024-11-18 15:32:02 +01:00
.editorconfig	feat: add `.editorconfig`	2024-11-04 11:07:42 +01:00
.gitignore	bootstrap with file from forgejo/releases	2023-03-26 17:51:25 +02:00
action.yml	feat(ci): use Release Notes Assistant	2024-11-18 15:32:02 +01:00
forgejo-release.sh	feat(ci): use Release Notes Assistant	2024-11-18 15:32:02 +01:00
LICENSE	LICENSE is MIT	2023-04-01 11:12:56 +02:00
README.md	feat(ci): use Release Notes Assistant	2024-11-18 15:32:02 +01:00
renovate.json	Add renovate.json	2024-11-20 14:01:08 +00:00

README.md

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`	`""`
`title`	Title of the release (defaults to tag)	`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`
`release-notes-assistant`	Generate release notes with Release Notes Assistant	`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