Publish GitHub Releases with Assets
A GitHub Action for creating and managing GitHub Releases across Linux, Windows, and macOS environments.
What is Publish GitHub Releases with Assets?
action-gh-release is a GitHub Action that automates the creation and management of GitHub Releases. It solves the problem of manually creating releases by integrating directly into CI/CD pipelines, allowing developers to upload assets, customize release details, and generate notes automatically. This streamlines the software delivery process and ensures consistent release practices.
Developers and DevOps engineers who use GitHub Actions for CI/CD and need to automate the creation of GitHub Releases as part of their workflow. It's particularly useful for open-source maintainers and teams managing versioned software releases.
Developers choose action-gh-release because it's a dedicated, well-maintained action that simplifies release automation with extensive customization options. Its cross-platform support and seamless integration with GitHub's release features make it a reliable alternative to manual release processes or custom scripts.
Overview
📦 :octocat: GitHub Action for creating GitHub Releases
Use Cases
Best For
- Automating GitHub Releases in CI/CD pipelines
- Uploading build artifacts and binaries to releases
- Generating release notes from external changelog files
- Managing draft and prerelease statuses programmatically
- Releasing software across multiple operating systems
- Integrating release automation with existing GitHub Actions workflows
Not Ideal For
- Projects using CI/CD platforms other than GitHub Actions (e.g., GitLab CI, Jenkins)
- Teams that prefer GUI-based release management without YAML configuration
- Workflows requiring complex, multi-step approval processes before release
- Organizations with security policies restricting personal access tokens for cross-repo operations
Pros & Cons
Pros
Works seamlessly on Linux, Windows, and macOS GitHub Actions runners, allowing consistent release automation across diverse environments, as highlighted in the README's description.
Supports glob patterns for uploading multiple files, with options for custom working directories and overwriting, making it easy to handle build artifacts, detailed in the 'Uploading release assets' section.
Offers numerous inputs for release name, tag, draft status, and discussion categories, enabling tailored release processes without imposing rigid conventions, as shown in the inputs table.
Can load release notes from external files, facilitating integration with changelog generators or manual curation, which is explicitly supported in the 'External release notes' part of the README.
Cons
Requires personal access tokens for cross-repository releases and specific permissions to trigger downstream workflows, adding setup overhead and security considerations, as admitted in the token and permissions notes.
GitHub normalizes filenames with special characters, and the action cannot fully dictate final download names, a noted limitation in the files input description that can affect asset branding.
Lacks built-in changelog creation, relying on external tools or GitHub's API, which adds extra steps to the workflow and may not suit teams wanting an all-in-one solution.
Frequently Asked Questions
Related Projects
Run GitHub Actions Locally in TerminalRun your GitHub Actions locally 🚀
Push Git changes to GitHub repository without authentication difficultiesGitHub actions to push back to repository eg. updated code
Publish a docker image to DockerhubA Github Action used to build and publish Docker images
Enforce Policies on GitHub Repositories and CommitsPolicy enforcement for your pipelines.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.