Git Product home page Git Product logo

Comments (5)

Slluxx avatar Slluxx commented on August 24, 2024 1

Sorry to disturb your vacation! Your action is great as is and i completely get the point of a simple one like this. Thanks for pointing me in another direction and i hope you have a few more great days ahead!

Cheers!

from changelog-generator.

metcalfc avatar metcalfc commented on August 24, 2024

Thats odd. So the bit that does the real work here is a one liner in bash:

log=$(git log "${base_ref}...${head_ref}" \
  --pretty=format:"* [\`%h\`](http://github.com/${repo_url}/commit/%H) - %s" \
  --reverse)

My guess is that the way you're doing the notes is getting wrecked in the shell via expansions. There are backticks in the short hash link so those could be getting evaluated. I'm not sure if there is a better way to escape those in a shell.

Have you considered using a release specific action instead of hub in shell script? https://github.com/marketplace/actions/create-release seems reasonably aligned:

    - uses: ncipollo/release-action@v1
      with:
        artifacts: "./*zip"
        name: "Release v${{ steps.set-version.outputs.version }}"
        body: "${{ steps.changelog.outputs.changelog }}"
        tag: "v${{ steps.set-version.outputs.version }}"
        token: ${{ secrets.GITHUB_TOKEN }}

from changelog-generator.

Slluxx avatar Slluxx commented on August 24, 2024

Allrighty, using release-action@v1 the body looks just like expected. I had a reason for using hub but i think that is obsolete so this solution is 100% better.


I do have 2 unrelated feature requests though:
Is it possible to display not just the commit title but also the description? like this:

  • 357e49f - Added: Includes now dumps of all currently available Emuiibos
    And here the commit description. more explanation without cramming important sentences into the title.
    Preferably multi line, for some beautiful formatted text. maybe the commit description can have markdown styling so it shows here perfectly?
  • 94a8cd6 - Changed: Update buildRelease.yml
  • a4452bc - Changed: python setup action
    again with body text

And my other, more advanced request would be to use keywords to group commit messages.
See this example: https://github.com/olivierlacan/keep-a-changelog/blob/master/CHANGELOG.md

Basically if a commit message starts with Added:, Removed:, Fixed: or Changed: it will group them together and display them like this (other if no prefix):

Added

  • 357e49f - Added: Includes now dumps of all currently available Emuiibos

Changed

  • 94a8cd6 - Changed: Update buildRelease.yml
  • a4452bc - Changed: python setup action

Other

  • 154c8b7 - Bumped Version to 2.1.0

Those 2 Features together would make this changelog-generator just absolutly perfect.

from changelog-generator.

Slluxx avatar Slluxx commented on August 24, 2024

@metcalfc hey you havent replied in a while. i know my text would belong in a new issue but may you still take a look at my suggestion?

from changelog-generator.

metcalfc avatar metcalfc commented on August 24, 2024

from changelog-generator.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.