From cba4325bb07b0efb388e1b5ed0425ad45702b7be Mon Sep 17 00:00:00 2001 From: Steve Ebersole Date: Thu, 22 Dec 2022 18:46:48 -0600 Subject: [PATCH] small post 6.2 cr1 tasks --- .../orm/post/DeprecationReportTask.java | 2 +- .../orm/post/IncubationReportTask.java | 15 ++++++++++ .../orm/post/InternalsReportTask.java | 18 ++++++++++-- .../src/release/announcement-template.adoc | 29 +++++++++++++++++++ 4 files changed, 61 insertions(+), 3 deletions(-) create mode 100644 release/src/release/announcement-template.adoc diff --git a/local-build-plugins/src/main/java/org/hibernate/orm/post/DeprecationReportTask.java b/local-build-plugins/src/main/java/org/hibernate/orm/post/DeprecationReportTask.java index 887456fdb4..6fa62fcafb 100644 --- a/local-build-plugins/src/main/java/org/hibernate/orm/post/DeprecationReportTask.java +++ b/local-build-plugins/src/main/java/org/hibernate/orm/post/DeprecationReportTask.java @@ -54,7 +54,7 @@ public class DeprecationReportTask extends AbstractJandexAwareTask { super.writeReportHeader( fileWriter ); try { - fileWriter.write( "# Union of everything annotated @Deprecated and/or @Remove" ); + fileWriter.write( "# All API elements considered deprecated - union of @Deprecated and @Remove" ); fileWriter.write( '\n' ); fileWriter.write( '\n' ); } diff --git a/local-build-plugins/src/main/java/org/hibernate/orm/post/IncubationReportTask.java b/local-build-plugins/src/main/java/org/hibernate/orm/post/IncubationReportTask.java index 39af7c97fd..381895360c 100644 --- a/local-build-plugins/src/main/java/org/hibernate/orm/post/IncubationReportTask.java +++ b/local-build-plugins/src/main/java/org/hibernate/orm/post/IncubationReportTask.java @@ -6,6 +6,8 @@ */ package org.hibernate.orm.post; +import java.io.IOException; +import java.io.OutputStreamWriter; import java.util.Comparator; import java.util.TreeSet; import javax.inject.Inject; @@ -42,4 +44,17 @@ public abstract class IncubationReportTask extends AbstractJandexAwareTask { writeReport( incubations ); } + @Override + protected void writeReportHeader(OutputStreamWriter fileWriter) { + super.writeReportHeader( fileWriter ); + + try { + fileWriter.write( "# All API elements considered incubating" ); + fileWriter.write( '\n' ); + fileWriter.write( '\n' ); + } + catch (IOException e) { + throw new RuntimeException( e ); + } + } } diff --git a/local-build-plugins/src/main/java/org/hibernate/orm/post/InternalsReportTask.java b/local-build-plugins/src/main/java/org/hibernate/orm/post/InternalsReportTask.java index 90f2d5cfca..129cf02e03 100644 --- a/local-build-plugins/src/main/java/org/hibernate/orm/post/InternalsReportTask.java +++ b/local-build-plugins/src/main/java/org/hibernate/orm/post/InternalsReportTask.java @@ -6,8 +6,8 @@ */ package org.hibernate.orm.post; -import java.io.File; -import java.nio.file.Path; +import java.io.IOException; +import java.io.OutputStreamWriter; import java.util.Comparator; import java.util.TreeSet; import javax.inject.Inject; @@ -40,4 +40,18 @@ public abstract class InternalsReportTask extends AbstractJandexAwareTask { writeReport( internals ); } + @Override + protected void writeReportHeader(OutputStreamWriter fileWriter) { + super.writeReportHeader( fileWriter ); + + try { + fileWriter.write( "# All API elements considered internal for Hibernate's own use" ); + fileWriter.write( '\n' ); + fileWriter.write( '\n' ); + } + catch (IOException e) { + throw new RuntimeException( e ); + } + } + } diff --git a/release/src/release/announcement-template.adoc b/release/src/release/announcement-template.adoc new file mode 100644 index 0000000000..f0f9a046b6 --- /dev/null +++ b/release/src/release/announcement-template.adoc @@ -0,0 +1,29 @@ += Hibernate {{version-here}} +Steve Ebersole +:awestruct-tags: ["Hibernate ORM", "Releases"] +:awestruct-layout: blog-post +:version: {{version-here}} +:docs-url: https://docs.jboss.org/hibernate/orm/{version} +:javadocs-url: {docs-url}/javadocs +:migration-guide-url: {docs-url}/migration-guide/migration-guide.html +:user-guide-url: {docs-url}/userguide/html_single/Hibernate_User_Guide.html + +// Text ... + + +== Conclusion + +For additional details, see: + +- the link:{user-guide-url}[User Guide] +- the link:{migration-guide-url}[Migration Guide] +- the https://hibernate.org/orm/releases/6.0/[release page] + +See also the following resources related to supported APIs: + +- the link:{docs-url}/incubating/incubating.txt[incubating API report] - `@Incubating` +- the link:{docs-url}/deprecated/deprecated.txt[deprecated API report] - `@Deprecated` + `@Remove` +- the link:{docs-url}/internals/internal.txt[internal API report] - internal packages, `@Internal` + +Visit the https://hibernate.org/community/[website] for details on getting in touch with us. +