Using --with-commit via args in orhun/git-cliff-action@v4 does not produce expected results

[jonathan8devs]

Description:

I’m trying to use git-cliff with the orhun/git-cliff-action@v4 GitHub action to generate a changelog and provide a specific commit message. My current configuration looks like this:

• name: Generate changelog
  uses: orhun/git-cliff-action@v4
  with:
  args: -v --with-commit '${{ steps.git_cliff_s02.outputs.commit_msg }}'

The value ${{ steps.git_cliff_s02.outputs.commit_msg }} is correctly set in a prior step, but it appears the output isn’t being used as expected. The generated changelog doesn’t include the entries I would expect as if the --with-commit option is ignored.

++ echo --config=cliff.toml -v --with-commit 'doc(changelog): Update to v3.1.0'
++ xargs
+ args='--config=cliff.toml -v --with-commit doc(changelog): Update to v3.1.0'

Expected Behavior:

I would expect the --with-commit option to generate a changelog entry as if the commit already existed, and that the changelog would reflect the commit message defined earlier.

Actual Behavior:

The generated changelog is empty or does not include any changes corresponding to the specified commit message.

# Changelog

Enjoy the magic of git cliff. All the git history of this repo in a beautified markdown format 🫶
## [unreleased]

[Compare with last version]
### 📚 Documentation


- *(changelog)* Update to v3.0.1 ([49f1857])

Question:

How can I correctly use the --with-commit option when providing the commit message from a previous step through args? Are there additional requirements or considerations I need to take into account?

[orhun]

git-cliff-action uses bash and I can reproduce it via this minimal example:

args=$(echo '-u --with-commit doc(changelog): Update to v3.1.0' | xargs)
git cliff $args

It happens because of the quotes/spaces handling... This is a bit annoying and I couldn't find the solution to it yet.

In the meantime you can set the GIT_CLIFF_WITH_COMMIT environment variable for setting commit messages.

[orhun]

Alright, I might have found a way to do this in #45

It's a bit ugly but it seems to be working with the following usage:

      - name: Generate a changelog
        id: git-cliff
        uses: orhun/git-cliff-action@fix/quote_handling
        with:
          args: --with-commit "\'test(changelog): add a custom commit\'"

Is there a chance that you can try it out?

[jonathan8devs]

I will be happy to test it in one of our repos in the coming days :)

[orhun]

Yo, any updates on this? 👀