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

Reading changelog - automate release bodies #192

Open
joepio opened this issue Nov 25, 2021 · 0 comments
Open

Reading changelog - automate release bodies #192

joepio opened this issue Nov 25, 2021 · 0 comments
Labels
type: feature request New feature or request

Comments

@joepio
Copy link

joepio commented Nov 25, 2021

Hi there! Thanks for creating and maintaining this.

I recently came across this github action: create-gh-release-action, which parses the CHANGELOG.md file and uses that to create a body for the release.

Might be cool this action supports a similar thing.

Users can also manually set it up using changelog-reader:

      - name: Get Changelog Entry
        id: changelog_reader
        uses: mindsers/changelog-reader-action@v2
        with:
          validation_depth: 10
          version: ${{ steps.tag_name.outputs.current_version }}
          path: ./CHANGELOG.md
      - name: Create/update release
        uses: ncipollo/release-action@v1
        with:
          # This pulls from the "Get Changelog Entry" step above, referencing it's ID to get its outputs object.
          # See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
          tag: ${{ steps.changelog_reader.outputs.version }}
          name: Release ${{ steps.changelog_reader.outputs.version }}
          body: ${{ steps.changelog_reader.outputs.changes }}
          prerelease: ${{ steps.changelog_reader.outputs.status == 'prereleased' }}
          draft: ${{ steps.changelog_reader.outputs.status == 'unreleased' }}
          allowUpdates: true
          token: ${{ secrets.GITHUB_TOKEN }}

But it would be even better if this was natively supported by this action.

@FabianLars FabianLars added the type: feature request New feature or request label Feb 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants