Skip to content

Conversation

@daveoconnor
Copy link
Collaborator

This PR is related to ticket #1750.

Changes:

  • Adds PDF generation of release reports with a new ReleaseReport model, and a draft+publish process w/ option to override to immediately publish.
  • Adds PDF generation as final step in "Do It All" for release tasks.
  • Minor: Adds LOCAL_DEVELOPMENT to celery docker compose config to enable pycharm debugger use.
  • Minor: Updates pycharm debugger libs versions.
  • Minor: fixes some invalid markup in the release report html.
  • Minor: Adds some missing steps to local hyperkitty db setup.

Chromium was used because weazyprint doesn't support javascript, which we need for the charts.

Testing:

    1. With a functioning ReportConfiguration set up, generate a release report as usual. In the admin UI confirm a report has been created in your local media folder under media/release-reports, which has a datetime value appended to the path. Pay attention the modification times of all files.
    2. In the admin UI check "published" and save, this should rename the file to remove the datetime value, saving it like release-report-boost-1-89-0.pdf
    3. Start a new release report process, confirm both files exist after creation. Publishing optional.
    4. Start a new release report process after checking off "Publish". This should overwrite the previous published release-report-boost-1-89-0.pdf.
  1. Under "Versions" in the admin UI click "do it all" and confirm that a new release report has been created.

For the PDFs confirm all fonts and data match what the previous traditional PDF generation process using the browser print dialog looked like.

Note:

  1. It's probably a good idea to keep an eye on the logs to confirm things are happening.
  2. Release report records are generated when the PDF generation begins and won't necessarily have a file name associated when you first check the admin list if it's too soon after the process has started, so you may need to give it a few minutes until the process has completed for the name to appear.

@daveoconnor daveoconnor force-pushed the doc/1750-release-report-enhancements branch from 6663a42 to 6d319ef Compare October 31, 2025 14:45
@karimarie67
Copy link
Collaborator

@gregjkal @rbbeeston Can you guys (or guy) please review? Thank you!

Copy link
Member

@rbbeeston rbbeeston left a comment

Choose a reason for hiding this comment

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

I'm good with this if Greg approves

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.

4 participants