Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
- Add README file
  • Loading branch information
nestordgs-tw committed Jan 26, 2023
1 parent 7b28049 commit b78a22e
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Issue Label to semver Level

A Github action to determine level of release according to labels in an issue

This action was created to help facilitate a GitHub Action "ChatOps" solution.

## Usage

---

```yaml
- name: Level lelease
uses: nestordgs-tw/issue-labels-to-level-release@main
with:
owner: ${{ github.repository_owner }}
repo: ${{ github.event.repository.name }}
issue_number: ${{ github.event.issue.number }}
labels_to_validate: '[{ "value": "patch", "label": "label1" },{ "value": "minor", "label": "label2" },{ "value": "major", "label": "label3" }]'
token: ${{ secrets.GITHUB_TOKEN }}
```
### Outputs
The level releated according to the labels. Note that in order to read the step output the action step must have an id.
```yaml
- name: Level lelease
id: level_release
uses: nestordgs-tw/issue-labels-to-level-release@main
with:
owner: ${{ github.repository_owner }}
repo: ${{ github.event.repository.name }}
issue_number: ${{ github.event.issue.number }}
labels_to_validate: '[{ "value": "patch", "label": "label1" },{ "value": "minor", "label": "label2" },{ "value": "major", "label": "label3" }]'
token: ${{ secrets.GITHUB_TOKEN }}
- name: Check outputs
run: |
echo "Level: ${{ steps.level_release.outputs.level }}"
```

0 comments on commit b78a22e

Please sign in to comment.