Skip to content

DEV: Fix changelog generator regarding whitespace and handling of "Other" group#2492

Merged
stefan6419846 merged 8 commits intomainfrom
improve-make-release
Mar 29, 2024
Merged

DEV: Fix changelog generator regarding whitespace and handling of "Other" group#2492
stefan6419846 merged 8 commits intomainfrom
improve-make-release

Conversation

@stefan6419846
Copy link
Copy Markdown
Collaborator

While having a look at generating a possible changelog for a new release, I stumbled upon some small bugs in the make_release.py script which are fixed by this PR:

  • The "Other" group would incorrectly render the list representation of the current group instead of the actual entries: [{'msg': ' Broken test due to expired test file URL (#2468)', 'author': 'pubpub-zz'}]

  • All groups would start with a leading whitespace, except the "Other" group:

    ### Testing (TST)
    -  Fix benchmark failures (#2481)
    -  Resolve file naming conflict in test_iss1767 (#2445)
    
    ### Other
    - : [{'msg': 'Improve lossless compression example (#2488)', 'author': 'j-t-1'}]
    - FIX: [{'msg': ' Broken test due to expired test file URL (#2468)', 'author': 'pubpub-zz'}]
    

To ensure that everything is working as intended, the tests have been fixed/extended to cover the current error cases.

@stefan6419846 stefan6419846 added the nf-packaging Non-functional change: Packaging and distribution label Mar 1, 2024
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.54%. Comparing base (719ff25) to head (d2f196b).
Report is 1 commits behind head on main.

❗ Current head d2f196b differs from pull request most recent head 8efe8db. Consider uploading reports for the commit 8efe8db to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2492      +/-   ##
==========================================
- Coverage   94.67%   94.54%   -0.14%     
==========================================
  Files          50       49       -1     
  Lines        8231     8176      -55     
  Branches     1646     1659      +13     
==========================================
- Hits         7793     7730      -63     
- Misses        268      276       +8     
  Partials      170      170              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pubpub-zz
Copy link
Copy Markdown
Collaborator

@MartinThoma
Can you have a review of this PR : You will be more relevant than I am

@pubpub-zz
Copy link
Copy Markdown
Collaborator

@MartinThoma Can you have a review of this PR : You will be more relevant than I am

+1 ?

@MartinThoma
Copy link
Copy Markdown
Member

Sorry, I was pretty busy with the improvements in the house and had no energy for pypdf for a while 🙈

MartinThoma
MartinThoma previously approved these changes Mar 29, 2024
Copy link
Copy Markdown
Member

@MartinThoma MartinThoma left a comment

Choose a reason for hiding this comment

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

Thank you for improving our DEV tools / CI 🙏

@stefan6419846
Copy link
Copy Markdown
Collaborator Author

It seems like something went wrong with the merge.

@stefan6419846
Copy link
Copy Markdown
Collaborator Author

Sorry, I was pretty busy with the improvements in the house and had no energy for pypdf for a while 🙈

No worries. It's still mostly FOSS done in the free time, thus enforcing such things does not feel right anyway ;)

Thank you for improving our DEV tools / CI 🙏

It seems like my fixes for the broken upstream merge removed your approval again. And yes, as long as I use it and I spot solvable issues, I try to fix it as well to reduce the manual work required afterwards.

@stefan6419846 stefan6419846 merged commit 253cde4 into main Mar 29, 2024
@stefan6419846 stefan6419846 deleted the improve-make-release branch March 29, 2024 14:43
stefan6419846 added a commit that referenced this pull request Apr 7, 2024
REL: 4.2.0

## What's new

### New Features (ENH)
- Allow multiple charsets for NameObject.read_from_stream (#2585) by @pubpub-zz
- Add support for /Kids in page labels (#2562) by @stefan6419846
- Allow to update fields on many pages (#2571) by @pubpub-zz
- Tolerate PDF with invalid xref pointed objects (#2335) by @pubpub-zz
- Add Enforce from PDF2.0 in viewer_preferences (#2511) by @pubpub-zz
- Add += and -= operators to ArrayObject (#2510) by @pubpub-zz

### Bug Fixes (BUG)
- Fix merge_page sometimes generating unknown operator 'QQ' (#2588) by @rfotino
- Fix fields update where annotations are kids of field (#2570) by @pubpub-zz
- Process CMYK images without a filter correctly (#2557) by @pubpub-zz
- Extract text in layout mode without finding resources (#2555) by @pubpub-zz
- Prevent recursive loop in some PDF files (#2505) by @pubpub-zz

### Robustness (ROB)
- Tolerate "truncated" xref (#2580) by @pubpub-zz
- Replace error by warning for EOD in RunLengthDecode/ASCIIHexDecode (#2334) by @pubpub-zz
- Rebuild xref table if one entry is invalid (#2528) by @pubpub-zz
- Robustify stream extraction (#2526) by @pubpub-zz

### Documentation (DOC)
- Update release process for latest changes (#2564) by @stefan6419846
- Encryption/decryption: Clone document instead of copying all pages (#2546) by @redfast00
- Minor improvements (#2542) by @j-t-1
- Update annotation list (#2534) by @j-t-1
- Update references and formatting (#2529) by @j-t-1
- Correct threads reference, plus minor changes (#2521) by @j-t-1
- Minor readability increases (#2515) by @j-t-1
- Simplify PaperSize examples (#2504) by @j-t-1
- Minor improvements (#2501) by @j-t-1

### Developer Experience (DEV)
- Remove unused dependencies (#2572) by @stefan6419846
- Remove page labels PR link from message (#2561) by @stefan6419846
- Fix changelog generator regarding whitespace and handling of "Other" group (#2492) by @stefan6419846
- Add REL to known PR prefixes (#2554) by @stefan6419846
- Release using the REL commit instead of git tag (#2500) by @MartinThoma
- Unify code between PdfReader and PdfWriter (#2497) by @pubpub-zz
- Bump softprops/action-gh-release from 1 to 2 (#2514) by @dependabot[bot]

### Maintenance (MAINT)
- Ressources → Resources (and internal name childs) (#2550) by @pubpub-zz
- Fix typos found by codespell (#2549) by @stefan6419846
- Update Read the Docs configuration (#2538) by @j-t-1
- Add root_object, _info and _ID to PdfReader (#2495) by @pubpub-zz

### Testing (TST)
- Allow loading truncated images if required (#2586) by @stefan6419846
- Fix download issues from #2562 (#2578) by @pubpub-zz
- Improve test_get_contents_from_nullobject to show real use-case (#2524) by @stefan6419846
- Add missing test annotations (#2507) by @stefan6419846

[Full Changelog](4.1.0...4.2.0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

nf-packaging Non-functional change: Packaging and distribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants