Skip to content

Commit

Permalink
docs: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Akryum committed Nov 29, 2021
1 parent 858fbe0 commit 8eeb62b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# release-tag

This is a fork of [actions/create-release](https://github.com/actions/create-release) with a single change: automatically determine whether a tag is a pre-release by checking for presence of `-` followed by a letter in the tag name.
This is a fork of [actions/create-release](https://github.com/actions/create-release) with the following changes:

Example:
- Automatically determine whether a tag is a pre-release by checking for presence of `-` followed by a letter in the tag name.
- Use [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog) to generate the changelog as release body.

Usage:

```yaml
name: Create release

# When a tag is pushed, create a release
on:
push:
tags:
Expand All @@ -20,7 +24,7 @@ jobs:
- name: Checkout code
uses: actions/checkout@master
with:
fetch-depth: 0
fetch-depth: 0 # Fetch all tags

- name: Create Release for Tag
id: release_tag
Expand All @@ -29,5 +33,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
preset: angular
preset: angular # Use conventional-changelog preset
```
Possible values for `preset`: `'angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jshint'`.

0 comments on commit 8eeb62b

Please sign in to comment.