Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Allow to use markdownlint format of keep-a-changelog version 2.2.0 #269

Closed
Ndpnt opened this issue Jan 25, 2023 · 6 comments · Fixed by #270
Closed

Allow to use markdownlint format of keep-a-changelog version 2.2.0 #269

Ndpnt opened this issue Jan 25, 2023 · 6 comments · Fixed by #270

Comments

@Ndpnt
Copy link

Ndpnt commented Jan 25, 2023

Hi,

Thanks for this useful GitHub Action to generate changelog.

We need to generate a changelog that respect markdownlint rules.
An update has been made on keep-a-changelog module in version 2.2.0 in this way.
Could you allow to specify the output format as parameter of this GitHub action?

Something like this:

name: Get version changelog
  on:
    ...

  jobs:
    get-changelog:
      steps:
        - uses: actions/checkout@v2
        - name: Get changelog
          id: get-changelog
          uses: @superfaceai/release-changelog-action@v2
          with:
            path-to-changelog: CHANGELOG.md
            version: 1.0.0
            format: markdownlint
        - name: Log changelog
          run: echo ${{ steps.get-changelog.outputs.changelog }}
@MattiSG
Copy link
Contributor

MattiSG commented Jan 25, 2023

That would be great indeed!

@janhalama FYI, following oscarotero/keep-a-changelog#28, the format is documented here 🙂

@janhalama
Copy link
Collaborator

I like your proposal. I will add the format parameter as you suggest with markdownlint and compact (default) options.

@janhalama
Copy link
Collaborator

Implemented in #270.

@Ndpnt
Copy link
Author

Ndpnt commented Jan 30, 2023

Thanks 🙏

@janhalama
Copy link
Collaborator

@Ndpnt, @MattiSG the markdownlint format support has been released in v2.1.1 the v2 tag has been updated to the latest version

@MattiSG
Copy link
Contributor

MattiSG commented Feb 5, 2023

Amazing, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants