powertools-lambda-java icon indicating copy to clipboard operation
powertools-lambda-java copied to clipboard

Maintenance: Add workflow to update changelog in GitHub and documentation

Open phipag opened this issue 5 months ago • 9 comments

Summary

Similar to other repositories such as https://github.com/aws-powertools/powertools-lambda-typescript we should include a GitHub workflow that automatically updates the CHANGELOG.md on GitHub and also the documentation on each version release.

Why is this needed?

Currently, the changelog is not kept up-to-date impacting the customer experience!

Which area does this relate to?

Automation

Solution

We should investigate using this GH action: https://github.com/aws-powertools/actions/tree/main/.github/actions/version-n-changelog

Acknowledgment

phipag avatar Aug 22 '25 13:08 phipag

@phipag I’m interested in contributing to this project. Could you please assign it to me?

aryannikhil avatar Aug 23 '25 08:08 aryannikhil

Hey @nikkhilaaryan, I think for this one it is better for a maintainer to pickup due to the permissions required for GitHub actions and a quicker testing feedback loop due to this fact. I assigned this issue to myself to reflect that.

I would like to encourage you to checkout any issues marked with good-first-issue issue label that is not yet assigned: https://github.com/aws-powertools/powertools-lambda-java/issues?q=is%3Aissue%20state%3Aopen%20label%3Agood-first-issue

Let me know if you have any questions.

phipag avatar Aug 25 '25 14:08 phipag

Hey @sthulb Pls work in this issue with @phipag

leandrodamascena avatar Sep 29 '25 13:09 leandrodamascena

PR merged. I will test it in the release today.

phipag avatar Oct 21 '25 09:10 phipag

There is an issue: https://github.com/aws-powertools/powertools-lambda-java/actions/runs/18680917425/job/53262600051.

The docker sha256 might be incorrectly formatted.

phipag avatar Oct 21 '25 11:10 phipag

Merged a PR to fix #2218. Retrying release workflow now.

phipag avatar Oct 21 '25 11:10 phipag

git tag is missing for Changelog. https://github.com/aws-powertools/powertools-lambda-java/actions/runs/18682982408/job/53269178397

phipag avatar Oct 21 '25 12:10 phipag

New PR: https://github.com/aws-powertools/powertools-lambda-java/pull/2219

phipag avatar Oct 21 '25 12:10 phipag

There is still an issue with the changelog generation. The generated CHANGELOG.md from the release workflow is empty now.

See this PR https://github.com/aws-powertools/powertools-lambda-java/pull/2220 at commit https://github.com/aws-powertools/powertools-lambda-java/pull/2220/commits/788bac217b603f6a3a9075e2f88b4aa4b44308a7

We need to fix this before the next release. I restore the file manually from main now.

phipag avatar Oct 21 '25 13:10 phipag