Skip to content

feat: automate changelog updates in pypi-publish workflow#55

Merged
ghinks merged 1 commit into
mainfrom
feat/automate-changelog
May 12, 2026
Merged

feat: automate changelog updates in pypi-publish workflow#55
ghinks merged 1 commit into
mainfrom
feat/automate-changelog

Conversation

@ghinks
Copy link
Copy Markdown
Owner

@ghinks ghinks commented May 12, 2026

This PR automates the process of updating the CHANGELOG.md file whenever a new version is published to PyPI.

Changes:

  • CHANGELOG.md: Initialized a new changelog file with a standard template.
  • .github/workflows/pypi_publish.yml:
    • Added a new Update Changelog step that:
      • Identifies the previous version tag.
      • Extracts commit messages between the previous tag and HEAD.
      • Formats and prepends these changes to CHANGELOG.md under a new version heading.
    • Updated the Commit Patch Bump step to include the updated CHANGELOG.md in the automatic version bump commit.

This ensures that the project history is consistently maintained without manual intervention during the release process.

@ghinks ghinks merged commit ee31c3f into main May 12, 2026
1 check passed
@ghinks ghinks deleted the feat/automate-changelog branch May 12, 2026 10:45
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7d0cde7c34

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

run: |
VERSION="${{ steps.bump.outputs.version }}"
DATE=$(date +%Y-%m-%d)
PREVIOUS_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Use tag before HEAD when deriving changelog range

When this workflow runs on the release trigger, checkout is at the release tag commit, so git describe --tags --abbrev=0 resolves to that same tag. The subsequent range ${PREVIOUS_TAG}..HEAD is therefore empty, which produces changelog entries without the commits for the released changes. This makes release notes inaccurate specifically for tag-triggered publishes.

Useful? React with 👍 / 👎.

@ghinks ghinks restored the feat/automate-changelog branch May 12, 2026 10:56
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.

1 participant