https://github.com/issue-ops/releaser
Handle creating GitHub Releases for a repository
https://github.com/issue-ops/releaser
actions github-actions issue-ops issueops
Last synced: 3 months ago
JSON representation
Handle creating GitHub Releases for a repository
- Host: GitHub
- URL: https://github.com/issue-ops/releaser
- Owner: issue-ops
- License: mit
- Created: 2023-09-20T13:47:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-09T14:59:27.000Z (4 months ago)
- Last Synced: 2026-02-11T05:06:12.537Z (4 months ago)
- Topics: actions, github-actions, issue-ops, issueops
- Language: TypeScript
- Homepage:
- Size: 5.18 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT
- Codeowners: CODEOWNERS
- Security: SECURITY
Awesome Lists containing this project
README
# IssueOps Releaser
Handle releases for GitHub repositories
> [!IMPORTANT]
>
> As of version `v2.0.0`, this action has been converted to ESM.
## About
This action is designed to be used in conjunction with
[`issue-ops/semver`](https://github.com/issue-ops/semver) to automate release
creation based on version information contained in your repository.
When developing with
[GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow),
changes are submitted through a pull request (PR) and eventually merged into the
default branch (e.g. `main`). Using [Semantic Versioning](https://semver.org/),
merging breaking changes, new features, or bugfixes constitutes a version change
and, depending on your strategy, a new release. This action automates the
creation of releases based on provided version tags and/or "commitish" values
(commit SHAs and branch names).
## Setup
Here are several simple examples of how to use this action in your workflow.
Make sure to replace `vX.X.X` with the latest version of each action.
### Automatic Versioning
In this case, the version is parsed from the provided project manifest, and is
used to tag the release.
```yaml
name: Continuous Delivery
on:
pull_request:
types:
- closed
branches:
- main
# This is required to be able to update tags and create releases
permissions:
contents: write
jobs:
release:
name: Release Version
runs-on: ubuntu-latest
# Only run this job if the PR was merged
if: ${{ github.event.pull_request.merged == true }}
steps:
# Checkout the repository, making sure to set fetch-depth to 0
- name: Checkout
id: checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
# Get the version and update the tags to use in the release
- name: Tag Commit
id: tag-commit
uses: issue-ops/semver@vX.X.X
with:
manifest-path: package.json
workspace: ${{ github.workspace }}
ref: main
# Use the version output from the previous step for the release
# Prepends a 'v' to the beginning (e.g. 'v1.2.3')
- name: Create Release
id: create-release
uses: issue-ops/releaser@vX.X.X
with:
tag: v${{ steps.tag-commit.outputs.version }}
```
### Manual Versioning
In this case, the version must be manually updated, such as from a GitHub
Actions variable.
```yaml
name: Continuous Delivery
on:
workflow_dispatch:
inputs:
version:
description: 'The version to release'
required: true
default: 'v0.0.0'
# This is required to be able to update tags and create releases
permissions:
contents: write
jobs:
release:
name: Release Version
runs-on: ubuntu-latest
# Only run this job if the PR was merged
if: ${{ github.event.pull_request.merged == true }}
steps:
# Checkout the repository, making sure to set fetch-depth to 0
- name: Checkout
id: checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
# Use the version from the input variable
- name: Create Release
id: create-release
uses: issue-ops/releaser@vX.X.X
with:
tag: ${{ inputs.version }}
```
## Inputs
| Input | Description |
| ------------------------ | ----------------------------------------------------------------------------------------- |
| `api_url` | The GitHub API URL to use |
| | Default: `${{ github.api_url }}` |
| `draft` | Whether or not the release should be a draft |
| | Default: `false` |
| `generate_release_notes` | Whether or not to generate release notes |
| | Default: `true` |
| `github_token` | The token to use for authentication |
| | Default: `${{ github.token }}` |
| `name` | The name of the release |
| | Default: The `tag` value |
| `notes` | The release notes, prepended to the generated notes if `generate_release_notes` is `true` |
| `owner` | The owner of the repository |
| | Default: The owner of the workflow repository |
| `prerelease` | Whether or not the release should be a prerelease |
| | Default: `false` |
| `repo` | The repository to create the release in |
| | Default: The workflow repository |
| `tag` | The tag to create or reference for the release |
| `target_commitish` | The branch or commit SHA to tag for the release (not required if the tag already exists) |
## Outputs
| Output | Description |
| ------------ | --------------------------------------- |
| `id` | The release ID |
| `html_url` | The URL to the release in the browser |
| `upload_url` | The URL to upload assets to the release |