Shebang for updating logging-parent to version 10.1.0-SNAPSHOT

.asf.yaml

@@ -35,14 +35,3 @@ github:
   protected_branches:
     main:
       required_signatures: true
-  # Attempt to make the auto-generated github emails more easily readable in email clients.
-  custom_subjects:
-    new_pr: "[PR] {title} ({repository})"
-    close_pr: "Re: [PR] {title} ({repository})"
-    comment_pr: "Re: [PR] {title} ({repository})"
-    diffcomment: "Re: [PR] {title} ({repository})"
-    merge_pr: "Re: [PR] {title} ({repository})"
-    new_issue: "[I] {title} ({repository})"
-    comment_issue: "Re: [I] {title} ({repository})"
-    close_issue: "Re: [I] {title} ({repository})"
-    catchall: "[GH] {title} ({repository})"

.github/generate-email.sh

@@ -33,19 +33,21 @@ fail_for_invalid_args() {
 
 # Constants
 PROJECT_NAME="Apache Log4j Tools"
+PROJECT_SITE="https://logging.apache.org/log4j/tools"
 PROJECT_REPO="https://github.com/apache/logging-log4j-tools"
+PROJECT_DIST_DIR="https://dist.apache.org/repos/dist/dev/logging/log4j-tools"
 PROJECT_VERSION="$2"
 COMMIT_ID="$3"
 
 # Check release notes file
-RELEASE_NOTES_FILE="$SCRIPT_DIR/../target/release-notes/$PROJECT_VERSION.md"
+RELEASE_NOTES_FILE="$SCRIPT_DIR/../src/site/_release-notes/_$PROJECT_VERSION.adoc"
 [ -f "$RELEASE_NOTES_FILE" ] || {
     stderr "Couldn't find release notes file: $RELEASE_NOTES_FILE"
     exit 1
 }
 
 dump_release_notes() {
-    awk "f{print} /^# $PROJECT_VERSION/{f=1}" "$RELEASE_NOTES_FILE"
+    awk "f{print} /^Release date::/{f=1}" "$RELEASE_NOTES_FILE"
 }
 
 case $1 in
@@ -59,7 +61,7 @@ This is a vote to release the $PROJECT_NAME $PROJECT_VERSION.
 
 Source repository: $PROJECT_REPO
 Commit: $COMMIT_ID
-Distribution: https://dist.apache.org/repos/dist/dev/logging/log4j
+Distribution: $PROJECT_DIST_DIR
 Nexus: https://repository.apache.org/content/repositories/orgapachelogging-1113
 Signing key: 0x077e8893a6dcc33dd4a4d5b256e73ba9a0b592d0
 
@@ -84,13 +86,12 @@ announce)
 To: log4j-user@logging.apache.org, dev@logging.apache.org
 Title: [ANNOUNCE] $PROJECT_NAME $PROJECT_VERSION released
 
-${PROJECT_NAME}[1] team is pleased to announce the $PROJECT_VERSION
+${PROJECT_NAME} team is pleased to announce the $PROJECT_VERSION
 release. This project provides tooling internally used by the
-Apache Log4j[2] project. For further information (support,
-download, etc.) see the project website[1].
+Apache Log4j project. For further information (support, download,
+etc.) see the project website[1].
 
-[1] $PROJECT_REPO
-[2] https://logging.apache.org/log4j
+[1] $PROJECT_SITE
 
 # Release Notes
 EOF

.github/workflows/build.yaml

@@ -19,10 +19,6 @@ name: build
 
 on:
   push:
-    # Avoid workflow run for _merged_ `dependabot` PRs.
-    # They were (hopefully!) already tested in PR-triggered workflow.
-    branches-ignore:
-      - "dependabot/**"
     paths-ignore:
       - "**.adoc"
       - "**.md"
@@ -38,26 +34,33 @@ permissions: read-all
 jobs:
 
   build:
+    if: github.actor != 'dependabot[bot]'
     uses: apache/logging-parent/.github/workflows/build-reusable.yaml@main
-    # Write permissions to allow merge of `dependabot` PRs
-    permissions:
-      contents: write
-      pull-requests: write
 
   deploy-snapshot:
     needs: build
-    if: github.repository == 'apache/logging-log4j-tools' && github.ref == 'refs/heads/main'
+    if: github.repository == 'apache/logging-log4j-tools' && github.ref_name == 'main'
     uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@main
-    secrets: inherit
+    # Secrets for deployments
+    secrets:
+      NEXUS_USER: ${{ secrets.NEXUS_USER }}
+      NEXUS_PW: ${{ secrets.NEXUS_PW }}
 
   deploy-release:
     needs: build
-    if: github.repository == 'apache/logging-log4j-tools' && startsWith(github.ref, 'refs/heads/release/')
+    if: github.repository == 'apache/logging-log4j-tools' && startsWith(github.ref_name, 'release/')
     uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@main
-    secrets: inherit
+    # Secrets for deployments
+    secrets:
+      GPG_SECRET_KEY: ${{ secrets.GPG_SECRET_KEY }}
+      LOGGING_STAGE_DEPLOYER_USER: ${{ secrets.LOGGING_STAGE_DEPLOYER_USER }}
+      LOGGING_STAGE_DEPLOYER_PW: ${{ secrets.LOGGING_STAGE_DEPLOYER_PW }}
+      SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
+      SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
     # Write permissions to allow the Maven `revision` property update, changelog release, etc.
     permissions:
       contents: write
     with:
-      project-name: log4j-tools
+      project-id: log4j-tools
       distribution-attachment-count: 2
+      site-enabled: true

.github/workflows/merge-dependabot.yaml

@@ -0,0 +1,42 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to you under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: merge-dependabot
+
+on:
+  pull_request_target:
+    paths-ignore:
+      - "**.adoc"
+      - "**.md"
+      - "**.txt"
+
+permissions: read-all
+
+jobs:
+
+  build:
+    if: github.repository == 'apache/logging-log4j-tools' && github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
+    uses: apache/logging-parent/.github/workflows/build-reusable.yaml@main
+
+  merge-dependabot:
+    needs: build
+    uses: apache/logging-parent/.github/workflows/merge-dependabot-reusable.yaml@main
+    permissions:
+      contents: write                                     # to push changelog commits
+      pull-requests: write                                # to close the PR
+    secrets:
+      GPG_SECRET_KEY: ${{ secrets.GPG_SECRET_KEY }}       # to sign commits

.mvn/jvm.config

@@ -9,3 +9,5 @@
 --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
 --add-opens jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
 --add-opens jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED
+--add-opens java.base/sun.nio.ch=ALL-UNNAMED
+--add-opens java.base/java.io=ALL-UNNAMED

README.adoc

@@ -19,45 +19,5 @@ https://github.com/apache/logging-log4j-tools/actions[image:https://github.com/a
 https://search.maven.org/search?q=g:org.apache.logging.log4j%20a:log4j-tools-bom[image:https://img.shields.io/maven-central/v/org.apache.logging.log4j/log4j-tools-bom.svg[Maven Central]]
 https://www.apache.org/licenses/LICENSE-2.0.txt[image:https://img.shields.io/github/license/apache/logging-log4j-tools.svg[License]]
 
-Tooling **internally** used by https://logging.apache.org/log4j/2.x/[the Apache Log4j project] infrastructure.
-
-xref:log4j-changelog/README.adoc[`log4j-changelog`]::
-Tools to maintain changelogs.
-
-xref:log4j-changelog-maven-plugin/README.adoc[`log4j-changelog-maven-plugin`]::
-Maven plugin for xref:log4j-changelog/README.adoc[`log4j-changelog`].
-
-== Build
-
-This project generates Java 8 bytecode, though requires Java 17 for compilation.
-You can build and test sources using `./mvnw verify` command.
-
-== 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:
-
-* ASF https://repository.apache.org/content/repositories/releases[Release] and https://repository.apache.org/content/repositories/snapshots[snapshot] repositories (mirrored to https://central.sonatype.dev/[the Maven Central Repository])
-* ASF https://downloads.apache.org/logging/log4j-tools[Distribution directory]
-
-See xref:RELEASING.adoc[release instructions] for further details.
-
-== Support
-
-Please keep in mind that this project is intended for internal usage only.
-You can use GitHub Issues for feature requests and bug reports – not questions!
-See https://logging.apache.org/log4j/2.x/support.html[the Log4j support policy] for details.
-
-== Security
-
-If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to mailto:security@logging.apache.org[the Log4j security mailing list].
-See https://logging.apache.org/log4j/2.x/security.html[the Log4j Security page] for further details.
-
-== License
-
-Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
-See xref:NOTICE.txt[] distributed with this work for additional information regarding copyright ownership.
-The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
-You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0[].
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and limitations under the License.
+Tooling **internally** used by https://logging.apache.org/log4j[the Apache Log4j project].
+See https://logging.apache.org/log4j/tools[the project website] for further information.