This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-parent.git
The following commit(s) were added to refs/heads/main by this push:
new abb7f76 Polish texts prior to release
abb7f76 is described below
commit abb7f76dc3d9814e43b6476516aeac633ae8f345
Author: Volkan Yazıcı <[email protected]>
AuthorDate: Mon Sep 4 10:35:11 2023 +0200
Polish texts prior to release
---
README.adoc | 48 +++++++++++++++++++++-
src/changelog/.1.x.x/.release-notes.md.ftl | 8 +++-
.../.1.x.x/add-reusable-build-workflow.xml | 2 +-
src/changelog/.1.x.x/use-changelog-plugin.xml | 2 +-
4 files changed, 55 insertions(+), 5 deletions(-)
diff --git a/README.adoc b/README.adoc
index 082127f..cf67f22 100644
--- a/README.adoc
+++ b/README.adoc
@@ -19,13 +19,59 @@
https://github.com/apache/logging-parent/actions[image:https://github.com/apache
https://search.maven.org/search?q=g:org.apache.logging%20a:logging-parent[image:https://img.shields.io/maven-central/v/org.apache.logging/logging-parent.svg[Maven
Central]]
https://www.apache.org/licenses/LICENSE-2.0.txt[image:https://img.shields.io/github/license/apache/logging-parent.svg[License]]
-This project contains the parent POM **internally** used by other Maven-based
https://logging.apache.org[Apache Logging Services projects].
+This project contains the parent POM and the reusable GitHub Actions workflows
**internally** used by other Maven-based https://logging.apache.org[Apache
Logging Services projects].
== Build
This project requires Java 17 for compilation.
You can build using `./mvnw verify` command.
+== Usage
+
+You can use this project as follows:
+
+. Add `org.apache.logging:logging-parent` as a `parent` to your `pom.xml`
+.. Check if `./mvnw verify` succeeds, otherwise make necessary changes
+. Copy and adapt following files:
+.. xref:src/changelog/.changelog.md.ftl[]
+.. xref:src/changelog/.index.md.ftl[]
+.. xref:.github/workflows/build.yml[]
+.. xref:.github/generate-email.sh[]
+.. xref:RELEASE-NOTES.md[]
+.. xref:RELEASING.adoc[]
+
+== Features
+
+This project aims to deliver the following features.
+
+=== Parent POM
+
+The provided parent POM features the following conveniences:
+
+* https://creadur.apache.org/rat[`apache-rat-plugin`] integration for license
preamble verification
+*
https://github.com/apache/logging-log4j-tools/tree/main/log4j-changelog-maven-plugin[`log4j-changelog-maven-plugin`]
integration for changelog and release note management
+*
https://maven.apache.org/enforcer/maven-enforcer-plugin/[`maven-enforcer-plugin`]
checks
+*
https://github.com/diffplug/spotless/tree/main/plugin-maven[`spotless-maven-plugin`]
integration for code formatting
+
+=== Reusable GitHub Actions workflows
+
+The provided reusable GitHub Actions workflows feature the following
conveniences:
+
+xref:.github/workflows/build-reusable.yml[`build-reusable.yml`]::
+* Compiles against Java 8 bytecode using the specified Java compiler version
+* Verifies reproducibility
+* Automatically merges verified `dependabot` PRs
+
+xref:.github/workflows/deploy-snapshot-reusable.yml[`deploy-snapshot-reusable.yml`]::
+* Deploys SNAPSHOT artifacts
+
+xref:.github/workflows/deploy-release-reusable.yml[`deploy-release-reusable.yml`]::
+* Deploys release artifacts
+* Generates the release notes
+* Generates the distribution ZIP containing Git-tracked sources, release
notes, binary attachments, `NOTICE.txt`, etc.
+* Generates the release vote & announcement emails
+* Uploads the distribution ZIP and emails to SVN
+
== Distribution
In accordance with the Apache Software Foundation's release
https://infra.apache.org/release-distribution.html[distribution policy] and
https://infra.apache.org/release-publishing.html[creation process], project
artifacts are _officially_ accessible from the following locations:
diff --git a/src/changelog/.1.x.x/.release-notes.md.ftl
b/src/changelog/.1.x.x/.release-notes.md.ftl
index 7026708..7a809a3 100644
--- a/src/changelog/.1.x.x/.release-notes.md.ftl
+++ b/src/changelog/.1.x.x/.release-notes.md.ftl
@@ -17,7 +17,11 @@
# ${release.version}<#if release.date?has_content> (${release.date})</#if>
-This minor release contains various improvements that we expect to relieve the
load on `pom.xml` and GitHub Actions workflows of projects we parent.
-This is of particular importance since Log4j is on an embark to break the main
repository into multiple repositories.
+This minor release contains various improvements that we expect to relieve the
load on `pom.xml` and GitHub Actions workflows of Maven-based projects we
parent.
+This is of particular importance while managing and cutting releases from
multiple repositories.
+See `README.adoc` for the complete list of features and their usage.
+
+See [this `logging-log4j-tools` GitHub Actions workflow
run](https://github.com/apache/logging-log4j-tools/actions/runs/6070379396)
demonstrating a successful release cut using a SNAPSHOT version of this
`logging-parent` release.
+All preparations (release notes, distribution ZIP, vote & announcement emails,
etc.) are staged to both Nexus and SVN and waiting the release manager to
proceed.
<#include "../.changelog.md.ftl">
diff --git a/src/changelog/.1.x.x/add-reusable-build-workflow.xml
b/src/changelog/.1.x.x/add-reusable-build-workflow.xml
index 0b9beec..53d4f9b 100644
--- a/src/changelog/.1.x.x/add-reusable-build-workflow.xml
+++ b/src/changelog/.1.x.x/add-reusable-build-workflow.xml
@@ -4,5 +4,5 @@
xsi:schemaLocation="http://logging.apache.org/log4j/changelog
https://logging.apache.org/log4j/changelog-0.1.1.xsd";
type="added">
<author id="github:vy"/>
- <description format="markdown">Added reusable GitHub Actions workflow to
share CI boilerplate for other repositories</description>
+ <description format="markdown">Added reusable GitHub Actions workflows to
share CI boilerplate for other repositories</description>
</entry>
diff --git a/src/changelog/.1.x.x/use-changelog-plugin.xml
b/src/changelog/.1.x.x/use-changelog-plugin.xml
index ec82e83..c77eb65 100644
--- a/src/changelog/.1.x.x/use-changelog-plugin.xml
+++ b/src/changelog/.1.x.x/use-changelog-plugin.xml
@@ -4,5 +4,5 @@
xsi:schemaLocation="http://logging.apache.org/log4j/changelog
https://logging.apache.org/log4j/changelog-0.1.1.xsd";
type="added">
<author id="github:vy"/>
- <description format="markdown">Start using
`log4j-changelog-maven-plugin`</description>
+ <description format="markdown">Switched to using
`log4j-changelog-maven-plugin` for managing changelog and release
notes</description>
</entry>
