ModelicaStandardLibrary icon indicating copy to clipboard operation
ModelicaStandardLibrary copied to clipboard

Fix release notes generation

Open beutlich opened this issue 3 years ago • 2 comments

The previously used docverter service for MD to HTML/PDF conversion was shut down and will not come back. This is an alternative implementation with local MD to HTML conversion and utilizing the docraptor service for HTML to PDF conversion.

It also fixes the GitHub Action introduced by #3886.

beutlich avatar Jun 20 '22 18:06 beutlich

Here's the successful test run: https://github.com/beutlich/ModelicaStandardLibrary/actions/runs/7575836490

beutlich avatar Jun 20 '22 19:06 beutlich

OK, we can wait until a new release is scheduled.

beutlich avatar Jul 04 '22 18:07 beutlich

OK, we can wait until a new release is scheduled.

@Harisankar-Allimangalath Since a new release is about to be scheduled we need to decide how to fix the release notes generation script. The proposed changes work for me as indicated by #4251 (though the free docraptor service only enables 5 documents per months w/o watermark).

beutlich avatar Jan 14 '24 09:01 beutlich

@beutlich there are 2 weeks left until we branch off. Do you think you and @Harisankar-Allimangalath can fix it by then?

casella avatar Jan 17 '24 00:01 casella

@beutlich there are 2 weeks left until we branch off. Do you think you and @Harisankar-Allimangalath can fix it by then?

Since I already spent quite some time on this PR I see three short-term options for the next MSL release:

  1. Accept as is (with the dependency on the docraptor service and their free plan of 5 watermark-free PDF documents per month). If it will break some day in future, well, let's revisit the topic by then.
  2. Remove/disable the PDF generation, that is only deploy the Markdown and HTML files of the auto-generated release notes.
  3. Remove the script (and CI trigger) from the repository, which does not mean, it can't be run from somewhere else.

beutlich avatar Jan 17 '24 06:01 beutlich