Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feat: add include-commit-links action input #135

Closed
FrancescoBonizzi opened this issue Apr 12, 2023 · 7 comments · Fixed by #136
Closed

feat: add include-commit-links action input #135

FrancescoBonizzi opened this issue Apr 12, 2023 · 7 comments · Fixed by #136
Assignees
Labels
enhancement New feature or request

Comments

@FrancescoBonizzi
Copy link

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:

image

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

Thanks.

@ardalanamini ardalanamini self-assigned this Apr 12, 2023
@ardalanamini
Copy link
Owner

@FrancescoBonizzi Hi,
Thanks for submitting this issue,
I'm happy to hear that you find this action useful.

For reference, is the screenshot from GitHub releases? Cause they're supposed to be presented like this.

@FrancescoBonizzi
Copy link
Author

Hi @ardalanamini! I used a Github action to write the changelog to a file (.md) then I just opened it via GitHub website.

Currently the workflow file is this:

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
          default-commit-type: 👨🏻‍💻 Cose tecniche
          mention-authors: false
          include-compare: false
          semver: 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/push@v1.3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          branch: main
          force: true
          message: 'Aggiornate note ultima release'

And a part of the raw .md file output is this:

## 🚀 Nuove feature
* App - aggiunto switch "Tieni lo schermo attivo" nel popup con gli step della ricetta (https://github.com/drilldownsrl/tuduu/commit/d281736c6c1d29e936ad1bf8dbc1536e8cf39bf8)
* App - aggiunto pulsante "STAMPA" per stampare gli step di una ricetta (https://github.com/drilldownsrl/tuduu/commit/cf53636b98984518f563e91b57fc0a80bbebfc63)
* App - gli ingredienti iniziano sempre con la maiuscola per uniformare la tipografia (https://github.com/drilldownsrl/tuduu/commit/e8a556e3923707f7e3e8670ec0fd3730dc02c3eb)

@ardalanamini
Copy link
Owner

Well, it's still interesting that GitHub is not showing the links the same consistent way 🤔
I'll have to take a look and see if it's an issue on my end!

As for the feature requested here, I'll add a new customization option as soon as possible.

@FrancescoBonizzi
Copy link
Author

Many many thanks! If I can help in some way, I'm here.

@ardalanamini ardalanamini added enhancement New feature or request and removed triage labels Apr 12, 2023
@ardalanamini ardalanamini changed the title Feature request - Add the config to not link the commit feat: add include-commit-links action input Apr 15, 2023
@ardalanamini ardalanamini changed the title feat: add include-commit-links action input feat: add include-commit-links action input Apr 15, 2023
@ardalanamini ardalanamini moved this from Todo to In Progress in auto-changelog Apr 15, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in auto-changelog Apr 15, 2023
@ardalanamini
Copy link
Owner

@FrancescoBonizzi It's released now, you can use the same version v3 but need to pass the following option:
include-commit-links: false
and maybe this one to omit the PR links too:
include-pr-links: false

@FrancescoBonizzi
Copy link
Author

A very nice job. I'd like to donate, is it possibile? :-)

@ardalanamini
Copy link
Owner

Unfortunately as of now I don't have a personal way to receive OSS donation and backing at the moment, except for some of my other projects and as a GitHub organization, hopefully that can change soon but I appreciate the interest and I'm glad that you find my work useful 🤘🏻

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants