Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix release notes generation #3999

Merged
merged 3 commits into from Jan 19, 2024

Conversation

beutlich
Copy link
Member

@beutlich beutlich commented Jun 20, 2022

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 beutlich added bug Critical/severe issue L: Resources Issue addresses Modelica/Resources (excl. C-Sources) CI Issue that addresses continuous integration labels Jun 20, 2022
@beutlich beutlich added this to the MSL4.1.0 milestone Jun 20, 2022
@beutlich beutlich force-pushed the fix-release-notes-generation branch 6 times, most recently from 5a18620 to d77574a Compare June 20, 2022 19:18
@beutlich
Copy link
Member Author

beutlich commented Jun 20, 2022

@beutlich beutlich added the V: 4.1.0-dev Issue originates in MSL v4.1.0-dev (and is not present in earlier releases) label Jun 20, 2022
Copy link
Member

@dietmarw dietmarw left a comment

Choose a reason for hiding this comment

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

I don't think relying (again) on a third-party service here is non-optimal. Why not run the PDF/HTML generation directly in the GH actions environment?

@beutlich
Copy link
Member Author

beutlich commented Jul 4, 2022

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

@beutlich
Copy link
Member Author

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).

@casella
Copy link
Contributor

casella commented Jan 17, 2024

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

@beutlich
Copy link
Member Author

@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.

Copy link
Member

@dietmarw dietmarw left a comment

Choose a reason for hiding this comment

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

I go for the pragmatic solution and go for "1. Accept as is".

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.
@beutlich beutlich marked this pull request as ready for review January 18, 2024 20:58
@beutlich beutlich removed the request for review from mtiller January 19, 2024 06:50
@beutlich beutlich merged commit a47caa4 into modelica:master Jan 19, 2024
2 checks passed
@beutlich beutlich deleted the fix-release-notes-generation branch January 19, 2024 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Critical/severe issue CI Issue that addresses continuous integration L: Resources Issue addresses Modelica/Resources (excl. C-Sources) V: 4.1.0-dev Issue originates in MSL v4.1.0-dev (and is not present in earlier releases)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants