Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/binpar/read-conventional-commit-changelog

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/binpar/read-conventional-commit-changelog
Owner: BinPar
Created: 2021-07-08T07:14:38.000Z (over 3 years ago)
Default Branch: develop
Last Pushed: 2022-12-12T09:02:06.000Z (about 2 years ago)
Last Synced: 2024-09-14T09:39:48.522Z (4 months ago)
Language: JavaScript
Size: 199 KB
Stars: 1
Watchers: 6
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        

# GitHub Action: Read conventional commit CHANGELOG

Reads the conventional commit generated CHANGELOG and outputs the requested version changes.

| **package version** | **github runner version** |

| :------------------ | :------------------------ |

| < v2.0.0            | < 2.297.0                 |

| >= v2.0.0           | >= 2.297.0                |

```yaml

- uses: BinPar/[email protected]

  with:

    # The CHANGELOG path. Defaults to ./CHANGELOG.md

    # Default: ./CHANGELOG.md

    changelog-path: ""

    # The version of the changelog to output. Defaults to latest

    # Default: latest

    version: ""

    # If false the action will not fail and instead returns empty string if an error

    # is raised. Defaults to true

    # Default: true

    fail: ""

```

| **Input**            | **Description**                                                                                            |   **Default**    | **Required** |

| :------------------- | :--------------------------------------------------------------------------------------------------------- | :--------------: | :----------: |

| **`changelog-path`** | The CHANGELOG path. Defaults to ./CHANGELOG.md                                                             | `./CHANGELOG.md` |  **false**   |

| **`version`**        | The version of the changelog to output. Defaults to latest                                                 |     `latest`     |  **false**   |

| **`fail`**           | If false the action will not fail and instead returns empty string if an error is raised. Defaults to true |      `true`      |  **false**   |

| **Output**          | **Description**               | **Default** | **Required** |

| :------------------ | :---------------------------- | ----------- | ------------ |

| `version-changelog` | The requested version changes |             |              |