orhun / git-cliff-action

GitHub action to generate a changelog based on the Git history
https://github.com/orhun/git-cliff
Apache License 2.0
117 stars 14 forks source link

feat: add version input variable #27

Closed M0NsTeRRR closed 1 week ago

M0NsTeRRR commented 2 months ago

The purpose of this PR is to allow setting the git-cliff release version without waiting to tag a new release for this action (and also pinning to a specific one). Unfortunately, it's not possible to update FROM from an argument, so we have to use bash or javaScript. This PR also addresses issue #18, as there is no Docker image to build or to pull. I preferred to download the binary to speed up the process (instead of installing python and the associated package for example).

The old action took around 6 seconds due to the Docker build, whereas this one takes 0 seconds.

If we implement this, we can close #26 as it will no longer be needed.

M0NsTeRRR commented 2 months ago

@orhun you can test it with my fork with m0nsterrr/git-cliff-action@v1.0.0

orhun commented 1 month ago

Hey, thanks for the PR! The shell script is scary at first glance, can we possibly split them into different files? (e.g. install.sh & run.sh)

Also, this will require a major version bump if I'm not mistaking, right? (e.g. v4)

M0NsTeRRR commented 1 month ago

Hey, thanks for the PR! The shell script is scary at first glance, can we possibly split them into different files? (e.g. install.sh & run.sh)

Also, this will require a major version bump if I'm not mistaking, right? (e.g. v4)

You're welcome. Yes, I agree... After reading the documentation, I found that it is possible to include local GitHub Action files. It should not be a breaking change as the user only manipulates input variables, but I'm not a GitHub Actions expert. 😊

M0NsTeRRR commented 1 month ago

I hate bash :smiling_face_with_tear:

M0NsTeRRR commented 1 month ago

You can test with m0nsterrr/git-cliff-action@v1.3.1