Action Library Create Release

| Home | Changelog | Contributing | Tech Doc |

---

Creates or updates a GitHub release and uploads packaged artifacts.

Behavior Summary

• Ensures gh is authenticated using GH_TOKEN or GITHUB_TOKEN.
• Downloads build artifacts (default name: Build Artifacts).
• Uses a matching logs/<version>.md file as release notes when available.
• Falls back to GitHub-generated notes when no log file is found.
• Creates the release and uploads artifacts with gh release upload.

Inputs

Name	Required	Description
release_version	Yes	Tag/version to create.
github_token	No	GitHub token for API access (defaults to GITHUB_TOKEN).
artifacts_path	No	Directory containing build artifacts (default: artifacts/assets).
artifacts_name	No	Artifact name to download (default: Build Artifacts).
download_artifacts	No	Download artifacts before release (default: true).
prerelease	No	true, false, or auto (default: auto).
draft	No	Create a draft release (true/false, default: false).

Outputs

Name	Description
release_version	Release version used for the tag.
release_url	URL of the created or updated release.

Permissions

• Requires contents: write to create releases and upload assets.

Requirements

• gh CLI (available on GitHub-hosted runners).
• actions/download-artifact@v4 for artifact retrieval.

Usage

- name: Create Release
  uses: crosswave-technology/ActionLibrary-Create-Release@master
  with:
    release_version: ${{ needs.detect-release.outputs.release_version }}
    artifacts_path: "artifacts/assets"

---

Return to Top

Copyright © Crosswave Technology Ltd