https://github.com/gandarez/changelog-action

Prints a formatted changelog between two tags or commit hashes.
https://github.com/gandarez/changelog-action

actions changelog git

Last synced: 2 months ago
JSON representation

Prints a formatted changelog between two tags or commit hashes.

• Host: GitHub
• URL: https://github.com/gandarez/changelog-action
• Owner: gandarez
• Created: 2021-03-28T15:50:56.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-22T13:05:00.000Z (4 months ago)
• Last Synced: 2024-09-23T15:34:44.957Z (3 months ago)
• Topics: actions, changelog, git
• Language: Go
• Homepage:
• Size: 40 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Changelog Action

This actions prints a formatted changelog.

## Example usage

### Basic

```yaml

- id: changelog

  uses: gandarez/changelog-action@v{latest}

- name: "Print changelog"

  run: echo "${{ steps.changelog.outputs.changelog }}"

```

### Advanced

```yaml

- id: changelog

  uses: gandarez/changelog-action@v{latest}

  with:

    current_tag: "v0.2.8"

    previous_tag: "v0.2.2"

    main_branch_name: "trunk"

    exclude: |

        ^Merge pull request .*

        Fix .*

    debug: true

- name: "Print changelog"

  run: echo "${{ steps.changelog.outputs.changelog }}"

```

## Inputs

| parameter           | required | description                                                                      | default     |

| ---                 | ---      | ---                                                                              | ---         |

| current_tag         |          | The current tag to be used instead of auto detecting.                            |             |

| previous_tag        |          | The previous tag to be used instead of auto detecting.                           |             |

| exclude             |          | Commit messages matching the regexp listed here will be removed from the output. |             |

| repo_dir            |          | The repository path.                                                              | current dir |

| debug               |          | Enables debug mode.                                                              | false       |

## Outpus

| parameter           | description              |

| ---                 | ---                      |

| changelog           | The formatted changelog. |