Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metadata update for publishing #5

Merged
merged 2 commits into from
Mar 28, 2021
Merged

Metadata update for publishing #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1843b65
update action metadata for publishing
kuritz Mar 26, 2021
0559162
more updates, docs
kuritz Mar 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# release
# Clubhouse Release

[![code style:
prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
![Test](https://github.com/farmersdog/clubhouse-pr/workflows/Test/badge.svg)

This action creates a formatted release in github from formatted commit messages annotated with clubhouse story data. [Clubhouse PR](https://github.com/marketplace/actions/clubhouse-pr)
can automatically format your PR titles (and commit messages, once merged) for use with this action.

## Inputs

### `ghToken`
Expand All @@ -20,13 +23,19 @@ Would you like to generate a changelog for this release?

Clubhouse story URL (ie. https://app.clubhouse.io/org/story)

### `tag`

The git tag for the current release.

### `previousTag`

Github tag of latest release
The git tag of the most recent prior release.

### `prerelease`

**Default** true
Would you like the release be created in the "prereleased" state?

**Default** false

## Development

Expand Down
12 changes: 6 additions & 6 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'Release'
description: 'Create a prerelease/release'
name: 'Clubhouse Release'
description: 'Create a formatted release in github from formatted commit messages'
inputs:
ghToken:
description: 'Github token'
Expand All @@ -10,13 +10,13 @@ inputs:
description: 'Would you like to generate a changelog for this release?'
default: true
tag:
description: 'Github tag'
description: 'The git tag for the current release'
required: true
previousTag:
description: 'The latest tag'
description: 'The git tag of the most recent prior release'
prerelease:
description: 'Is this a prerelease?'
default: true
description: 'Would you like the release be created in the "prereleased" state?'
default: false
runs:
using: 'node12'
main: 'dist/index.js'