How do I use Github-Release-Action with GitHub Enterprise?

Set the GH_HOST environment variable to your enterprise instance URL and use GH_ENTERPRISE_TOKEN for authentication, as shown in the README example. This allows the action to publish releases on self-hosted GitHub setups seamlessly.

Github-Release-Action vs actions/create-release: which should I choose?

Choose Github-Release-Action if you need a minimalist tool focused only on metadata without asset bundling; actions/create-release is better for attaching assets or if you prefer GitHub's official action with more integrated features. Consider your workflow's complexity and asset needs.

Can Github-Release-Action attach files like binaries to releases?

No, it explicitly avoids asset attachment, as stated in the description. For attaching files, you'll need to use additional steps in your workflow, such as GitHub's upload-release-asset action or custom scripts.

How to set up token permissions for Github-Release-Action?

Configure the GITHUB_TOKEN with write permissions for contents and packages, either via repository settings or by adding a permissions block in your job YAML. The README provides details on both methods to ensure proper authorization.

Does Github-Release-Action support generating changelogs automatically?

No, it only allows setting a custom title for release notes. For automated changelog generation, you'd need to combine it with other actions or tools that parse commit history before passing data to this action.

What are the best alternatives to Github-Release-Action for release automation?

Consider actions like actions/create-release for asset bundling, semantic-release for semantic versioning and changelogs, or release-it for more comprehensive CLI-based workflows. The choice depends on your need for simplicity versus feature richness.

How do I mark a release as a prerelease using this action?

Use the 'prerelease' input parameter set to true in your workflow YAML, as demonstrated in the README. This flags the release as a prerelease on GitHub, useful for beta or testing versions.

Open-Awesome

Add releases to GitHub

MITShellrelease-20241111151247

A GitHub Action that creates plain GitHub releases without attaching assets or source code.

GitHub

215 stars59 forks0 contributors

What is Add releases to GitHub?

Github-Release-Action is a GitHub Action that creates plain GitHub releases without attaching assets or source code. It automates release generation in CI/CD pipelines, allowing developers to tag versions and publish release notes with minimal configuration. It solves the need for lightweight release automation in projects where assets are managed separately.

Target Audience

Developers and DevOps engineers using GitHub Actions for CI/CD who need automated release creation without asset bundling.

Value Proposition

It offers a focused, no-frills approach to release automation, reducing complexity compared to asset-heavy alternatives. Developers choose it for its simplicity, GitHub Enterprise support, and seamless integration into existing workflows.

Overview

Publish Github releases in an action

Use Cases

Best For

Automating version releases in CI/CD pipelines
Creating prereleases for testing and staging
Integrating with GitHub Enterprise self-hosted instances
Projects that manage release assets separately
Workflows requiring custom release tags
Minimalist release automation without asset handling

Not Ideal For

Projects that require automatic attachment of binaries or archives to GitHub releases
Teams needing automated changelog generation from commit history or issue trackers
Workflows where release notes must include rich formatting or extensive metadata
CI/CD pipelines integrated with external asset management systems that demand bundled releases

Pros & Cons

Pros

Minimalist and Focused

It solely handles release metadata like titles and tags, avoiding bloat from asset bundling, which simplifies configuration and reduces overhead in CI/CD pipelines.

GitHub Enterprise Support

Includes built-in compatibility for self-hosted instances via GH_HOST and GH_ENTERPRISE_TOKEN environment variables, as noted in the README, making it versatile for corporate environments.

Custom Tag Flexibility

Allows overriding default tags with custom values, enabling tailored versioning schemes without being tied to Git tag triggers.

Prerelease Capability

Supports marking releases as prereleases with a simple boolean flag, facilitating testing and staging workflows directly from automation.

Simple Token Integration

Works with standard GITHUB_TOKEN or enterprise tokens, and the README provides clear guidance on permission setup, easing integration into existing GitHub Actions.

Cons

No Asset Handling

Forces teams to rely on separate actions or manual processes for attaching files, adding complexity to workflows that require bundled releases.

Limited Release Notes

Only supports a basic title field for release notes, lacking features like auto-generated changelogs, which means developers must manually curate or use additional tools.

Token Permission Overhead

The README admits that configuring GITHUB_TOKEN permissions requires either global settings or job-level tweaks, which can be confusing and error-prone for beginners.

Niche Use Case Dependence

Its minimalist design makes it only suitable for specific scenarios, often necessitating complementary tools for full release automation, potentially increasing toolchain complexity.

Frequently Asked Questions

Related Projects

Run GitHub Actions Locally in Terminal

Run your GitHub Actions locally 🚀

Stars70,554

Forks1,945

Last commit12 days ago

Publish GitHub Releases with Assets

📦 :octocat: GitHub Action for creating GitHub Releases

Stars5,645

Forks624

Last commit1 day ago

Push Git changes to GitHub repository without authentication difficulties

GitHub actions to push back to repository eg. updated code

Stars1,270

Forks239

Last commit7 days ago

Publish a docker image to Dockerhub

A Github Action used to build and publish Docker images

Stars791

Forks204

Last commit26 days ago

Community-curated · Updated weekly · 100% open source

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.

Submit a project Star on GitHub