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

Generate changelog for releases #84

Closed
wants to merge 92 commits into from
Closed

Generate changelog for releases #84

wants to merge 92 commits into from

Conversation

MichaelKora
Copy link
Contributor

Fixes #8

@MichaelKora MichaelKora marked this pull request as ready for review March 22, 2023 09:37
@MichaelKora MichaelKora requested a review from raminqaf March 29, 2023 09:53
Copy link

@torbsto torbsto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

configuration: "${{ inputs.config }}"
fromTag: "${{ inputs.old-tag }}"
toTag: "${{ inputs.new-tag }}"
outputFile: "${{ inputs.output }}"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like this action has a number of output, among others outputs.changelog. Can we also use an output instead of writing it to a temporary file?

Copy link
Member

@yannick-roeder yannick-roeder Mar 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you mean something like this then?

echo "changelog=${{ steps.build_changelog.outputs.changelog }}" >> "$GITHUB_OUTPUT"

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the temporary file was only a workaround. I think using the output is much cleaner because we have one less parameter and users don't need to worry that we add a file that they might accidentally commit and push

Copy link
Contributor Author

@MichaelKora MichaelKora Apr 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@torbsto @yannick-roeder @raminqaf

in order to modify this the generate Changelog before adding it to the main Changelog, we need to store it in a tmp file.

However, if we do not wish to change the Changelog file in this composite action and want to return the raw Changelog instead, then we do not need a composite action at all. because the used action already does that.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MichaelKora @yannick-roeder Just to clarify, I do want to update the changelog file, but I also need the generated changelog for the GitHub release later on, for example in Quick:

actions/generate-changelog/action.yaml Show resolved Hide resolved
@MichaelKora MichaelKora requested a review from torbsto March 31, 2023 12:09
@MichaelKora
Copy link
Contributor Author

I'm closing this PR since there's no persuasive reason to add any new features to the existing one.

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 this pull request may close these issues.

Action to create a changelog
4 participants