diff --git a/README.md b/README.md index 5a7b9e0..e16097a 100644 --- a/README.md +++ b/README.md @@ -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` @@ -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 diff --git a/action.yml b/action.yml index 1dfecbc..49ae25b 100644 --- a/action.yml +++ b/action.yml @@ -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' @@ -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'