https://github.com/higebu/conventional-commits-parser-action

conventional-commits-parser-action
https://github.com/higebu/conventional-commits-parser-action

Last synced: 27 days ago
JSON representation

conventional-commits-parser-action

• Host: GitHub
• URL: https://github.com/higebu/conventional-commits-parser-action
• Owner: higebu
• Created: 2021-07-14T01:25:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-05T13:05:55.000Z (almost 3 years ago)
• Last Synced: 2024-10-04T19:44:31.756Z (3 months ago)
• Language: JavaScript
• Size: 960 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# conventional-commits-parser-action

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

A GitHub Action to parse commit and set outputs based on conventional commits.

## Setup

```yaml

on:

  push:

    branches:

      - main

name: test

jobs:

  test:

    runs-on: ubuntu-latest

    steps:

      - uses: higebu/conventional-commits-parser-action@v1

        id: parser

      - run: |

          echo 'this step will be run if the commit type is `fix`'

        if: ${{ steps.paser.outputs.type == 'fix' }}

```

## Configuration

| output | description |

|:---:|---|

| `commit_parsed` | `true` if the commit was parsed, `false` otherwise |

| `type` | The commit type |

| `scope` | The commit scope |

| `breaking_change` | `true` if the commit is breaking change, `false` otherwise |

| `text` | The commit text |