jaywcjlove / changelog-generator Goto Github PK

When using the following template with one commit fix: some weird bug

## Bugs
{{fix}}
## Feature
{{feat}}
## Improve
{{refactor,perf,clean}}
## Misc 
{{chore,style,ci||🔶 Nothing change}}
## Unknown
{{__unknown__}}

The following changelog is generated:

## Bugs
- fix: some weird bug 1234567 @username
## Improve
{{refactor,perf,clean}}
## Misc 
🔶 Nothing change

Instead of:

## Bugs
- fix: some weird bug 1234567 @username
## Misc 
🔶 Nothing change

It seems like the RegEx on this line is not correct.

Wrong title.

Is their possibly a way to support fetching info from another repo? Rather than the one the action is running on? I have a private repo which has the same content as the public one, and I'd like to be able to pull that data in the private repo.

Didn't see any options for this.

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

When add this action to a repo that has no releases yet, it throws an error.

Maybe it should just generate and empty changelog? Or a message "First release".

I am using this as a workaround to conditionally run the step only if previous tags exist via if: env.previous_tag:

    - name: previous tag
      run: |
        # set previous_tag to the last tag in the repo
        # or if the command throws an error, set it to nothing
        previous_tag=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
        echo "previous_tag=$previous_tag" >> $GITHUB_ENV

    - name: Generate changelog
      id: changelog
      if: env.previous_tag
      uses: jaywcjlove/changelog-generator@main
      with:
        token: ${{ secrets.GITHUB_TOKEN }}

There is an wrong example in the README.

Hi, thank for great work, I highly appreciate the convenience provided by this tool and I would like to contribute some ideas to further enhance its functionality.

1. Currently, the changelog is listed from top to bottom in chronological order, starting from the oldest to the newest. I want to categorize them into separate types. For example, feat will be listed under #Feature, fix will be under #Bugs, and so on for other types.

2. Sometimes, there are commits that I don't want to appear in the changelog, so I have used the following filter:
   ^(?!type\b|feat\b|style\b|chore\b|doc\b|docs\b|build\b|fix\b|test\b|refactor\b|website\b|revert\ b|clean\b|perf\b|ci\b).*
   Therefore, I think there should be an option to allow users to create a custom type and include or exclude it from the changelog.

3. Some my projects are developed solely by me, there should also be an option to hide the author, as all commits are mine. I don't find it necessary to display @author on every entry in the changelog.

To enable the use in monorepo projects, I would like to be able to create different changelogs based on project path commits

Suggestion:

- name: Generate changelog
    id: changelog
    uses: jaywcjlove/changelog-generator@main
    with:
      token: ${{ secrets.GITHUB_TOKEN }}
      path: ./apps/my-aplication
    continue-on-error: true

First, Thank You for this simple and easy to use tool! 🙏

When using a changelog template you get something like this:

### Feature

- feat: my feature

when the conventional commit types are known, and when the template is used, it would be nice to be able to filter away the redundant types from the beginning of the commit message. Ie:

### Feature

- my feature

### Unkown

- notconventional: other commit

Latter is much more readable and human-friendly -- would be nice to be able to do this 👍

I am not the type of person that really likes the idea of having emojis in my release note. Is it possible to implement a param in the config file to remove the emojis, just texts?

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

• chore(deps): update peaceiris/actions-gh-pages action to v4

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository