refactor: golden file render tests for changelog #82
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
also cleanup changelog render code
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the changelog rendering functionality by extracting it into a separate module with golden file tests. The changes improve code organization and add comprehensive test coverage for changelog rendering functions.
- Moved changelog rendering functions from
main.goto a dedicatedchangelog.gofile - Added golden file tests for both screen and markdown changelog rendering
- Cleaned up the changelog rendering implementation with better variable naming and use of
strings.Builder
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| main.go | Removed changelog functions and updated function calls to use new capitalized names |
| changelog.go | New file containing refactored changelog rendering functions with improved implementation |
| changelog_test.go | Added comprehensive golden file tests with sample commit data |
| go.mod | Added google/go-cmp dependency for test comparisons |
| testdata/sample_screen.golden | Golden file for screen changelog output format |
| testdata/sample_markdown.golden | Golden file for markdown changelog output format |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This should make any future UX refactoring easier. Also cleans up changelog render code a tiny bit while I'm in there.