ardalanamini / auto-changelog Goto Github PK

Recreate:

1. Create and push some commits to your default (main) branch.
2. List your commits. Let's say your commits look like this:

$ git log --pretty=oneline
15027957951b64cf874c3557a0f3547bd83b3ff6 Merge branch 'experiment'
a6b4c97498bd301d84096da251c98a07c7723e65 feat: Create write support
0d52aaab4479697da7686c15f77a3d64d9165190 feat: One more thing
6d52a271eda8725415634dd79daabbc4d9b6008e Merge branch 'experiment'
0b7434d86859cc7b8c3d5e1dddfed66ff742fcbc feat: Add commit function
9fceb02d0ae598e95dc970b74767f19372d61af8 feat: Update rakefile

3. Create a tag with an older commit than the most recent on in the main branch.

git tag v1.2 0b7434d
git push origin v1.2

The release github action is triggered:

name: Create Release

on:
  push:
    tags:
      - 'v*'
jobs:
  create-release:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Changelog
        id: changelog
        uses: ardalanamini/auto-changelog@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}

The ${{ steps.changelog.outputs.changelog }} value will include all the commits:

Create write support
One more thing
Add commit function
Update rakefile

It should just checkout the tag and include only the changes between the previous tag and the current tag. Or if this is the first tag of the repository, it should include everything up to just the commit the tag refers to.

Consider these commits:

They are automatic, usually I forget to amend their message to add a prefix. I'd like to exclude those from the changelog, as they appear like this:

Is there a way to configure the action to exclude it? (I would exclude this if it starts with "Merge"

Hey there! I really fancy this action and you have done a very good job on it!
I'd just fancy requesting and favor having this implemented into the action itself:

The ability to specify a tag-pattern to select and compare latest commits with rather than all commits in a specified tag.

For example, in the specified image below, the specified tag-pattern should be player and it should retrieve the latest commits between it and the latest (similar) tag:

Since my changelogs currently appear as this, it just becomes unreadable and I haven't found any other workaround for it:

It'd be handy if they appeared similarly to the following attachment upon release, with the newly specified tag-pattern and its corresponding value of player only revealing the latest commit differences between the new and last tags with said pattern:

It should utilize something similar to this:

Thank you again maintaining this wonderful GitHub Action!

Warning: The set-output command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

This message is shown while building the change-log. I have no issue regarding the working of the GitHub Action but its just that this message has been bothering me. Thank you.

I have copy pasted the example code, commited with the message "ci: Testing ci", and the action just does not output anything.
::set-output name=changelog:: ##[debug]steps.generate-changelog.outputs.changelog=

Hi! Thanks for the useful action!

I noticed that some of my commits don't make it to the changelog. I found that it happens to all commits with multiline messages. I suspect that the problem is in the commit regex:

But I'm not sure how to fix it. Could you look into it?

I want to cooperate with the automatic creation of release action, but every time the complete changelog is generated, can I only generate the changelog after the last release?

Hi and thanks for this very useful action!
I'd like just one thing: a config parameter to skip adding the whole commit link.

Example:

As you can see after the commit name there a big link.

Thanks.

Hi! I'm using your very useful action in a lot of my projects, but I have a problem in just one. Although the action is the same (Copy pasted) and although I create releases and tags in the same manner, in one repo it always takes all commits instead of just taking the commits from the last release.

The GitHub action:

name: 📝 Generate release notes
on:
  release:
    types: [published]
  workflow_dispatch:
  
jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - name: Changelog
        uses: ardalanamini/auto-changelog@v3
        id: changelog
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          commit-types: |
            feat: 🚀 Nuove feature
            feature: 🚀 Nuove feature
            fix: 🐞 Bugfix
            perf: 📈 Migliorie di performance
            test: 👨‍🔬 Test
            chore: 🧹 Pulizia codice
          default-commit-type: 👨🏻‍💻 Cose tecniche
          mention-authors: false
          include-compare: false
          semver: false
          include-commit-links: false
          include-pr-links: false

      - name: last-release-notes.md - Checkout repo
        uses: actions/checkout@v3
        
      - name: last-release-notes.md - Write
        uses: DamianReeves/write-file-action@master
        with:
          path: ./last-release-notes.md
          contents: | 
            ${{steps.changelog.outputs.changelog}}
          write-mode: overwrite 

      - name: last-release-notes.md - Commit & Push
        uses: Andro999b/[email protected]
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: main
          force: true
          message: 'Aggiornate note ultima release'

The output:

...and so on.

My tags:

I expected, as it is doing in my other repos, that it would take only the commits beginning from the v2.2.17.

Do you have any clue? Maybe is there some commit name that breaks it? Can I do something to help you investigate this?

Thanks.

I have set semver: true and the release type is prerelease , However I am still getting the ${{ steps.changelog.outputs.prereleas}} value false.

below is the code I have used.

  - name: Changelog
    uses: ardalanamini/auto-changelog@v3
    id: changelog
    with:
      github-token: ${{ github.token }}
      mention-authors: true
      mention-new-contributors: true
      include-compare: true
      semver: true

  - name: Append the CHANGELOG.md
    shell: bash
    run: |
      echo  ${{ steps.changelog.outputs.prerelease }}