phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[doc] Prerender includes in release notes

Browse Source
This commit is contained in:
Andreas Dangel 2024-03-14 13:32:33 +01:00
parent d54b8b3e8f
commit 7668fe23d0
No known key found for this signature in database
GPG Key ID: 93450DF2DF9A3FA3
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/pages/release_notes_pmd7.md
View File

@ -51,10 +51,10 @@ Contributors: [Clément Fournier](https://github.com/oowekyala) (@oowekyala),
[Andreas Dangel](https://github.com/adangel) (@adangel),
[Juan Martín Sotuyo Dodero](https://github.com/jsotuyod) (@jsotuyod)
{% include note.html content="
<div class="alert alert-info" role="alert"><i class="fas fa-info-circle"></i> <b>Note:</b>
The full detailed documentation of the changes to the Java AST are available in the
[Migration Guide for PMD 7](pmd_userdocs_migrating_to_pmd7.html#java-ast)
" %}
</div>
### Revamped Command Line Interface
@ -664,10 +664,10 @@ The rules have been moved into categories with PMD 6.
## 💥 Compatibility and Migration Notes
{% include note.html content="
<div class="alert alert-info" role="alert"><i class="fas fa-info-circle"></i> <b>Note:</b>
The full detailed documentation of the changes are available in the
[Migration Guide for PMD 7](pmd_userdocs_migrating_to_pmd7.html)
" %}
</div>
### For endusers

4
docs/render_release_notes.rb
View File

@ -39,6 +39,10 @@ liquid_env = {
to_render = File.read(release_notes_file)
if to_render.match(/\{%\s*include/)
STDERR.printf("\n\n\e[31;1mERROR\e[0m Detected an include tag - this is jekyll specific and not supported here! Please replace it manually\n\n")
exit 1
end
rendered = Liquid::Template.parse(to_render).render(liquid_env)