Skip to content

Commit

Permalink
docs: add example and description (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
flukolo4ek authored Nov 19, 2024
1 parent 530afd8 commit ba689da
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,29 @@
[![CI](https://github.com/datalens-tech/get-next-release-version-action/workflows/Check%20PR/badge.svg)](https://github.com/datalens-tech/get-next-release-version-action/actions?query=workflow%3A%22%22Check+PR%22%22)
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Get%20Next%20Release%20Version-blue.svg)](https://github.com/marketplace/actions/get-next-release-version)

Action for automatically generate next release version

Get Next Release Version Action

## Usage

### Example

```yaml
placeholder # TODO: Add example
jobs:
get_version:
permissions:
contents: read
outputs:
version: ${{ steps.get_version.outputs.version }}
steps:
- name: Get Version
id: get_version
uses: datalens-tech/get-next-release-version-action@v1
with:
version_shift: patch
version_override: v1.0.0
release_filter_target_commitish: main
```
### Action Inputs
Expand Down

0 comments on commit ba689da

Please sign in to comment.