Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 2.07 KB

release-tag.md

File metadata and controls

48 lines (29 loc) · 2.07 KB

"Release" workflow

Make a GitHub release with changelog on release tag push.

Installation

Workflow

Install the release-tag.yml GitHub Actions workflow to .github/workflows/

Readme badge

Markdown badge:

[![Release status](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/release-tag.yml/badge.svg)](https://github.com/TODO_REPO_OWNER/TODO_REPO_NAME/actions/workflows/release-tag.yml)

Replace the TODO_REPO_OWNER and TODO_REPO_NAME placeholders in the URLs with the final repository owner and name (example).

Asciidoc badge:

image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/release-tag.yml/badge.svg["Release status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/release-tag.yml"]

Define the {repository-owner} and {repository-name} attributes and use them throughout the readme (example).

Commit message

Add GitHub Actions workflow to generate releases

On every push of a release tag (e.g., "1.2.3" or "v1.2.3") to the repository, create a GitHub release with a raw
changelog generated from the commit history since the last release tag.

Tags that contain a pre-release version will cause the GitHub release to be marked as a pre-release.

PR message

On every push of a release tag (e.g., `1.2.3` or `v1.2.3`) to the repository, create a [GitHub release](https://docs.github.com/repositories/releasing-projects-on-github/about-releases) with a raw [changelog generated](https://github.com/arduino/create-changelog) from the commit history since the last release tag.

Tags that contain a [pre-release version](https://semver.org/#spec-item-9) will cause the GitHub release to be marked as a pre-release.