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-log4j-jmx-gui.git
The following commit(s) were added to refs/heads/main by this push: new 195a926 Upgrade `logging-parent` to version `11.0.0` and migrate to Antora (apache/logging-log4j2#2443) 195a926 is described below commit 195a926181a925e7852de694fa151cef5a35dae8 Author: Volkan Yazıcı <vol...@yazi.ci> AuthorDate: Fri Apr 19 13:50:41 2024 +0200 Upgrade `logging-parent` to version `11.0.0` and migrate to Antora (apache/logging-log4j2#2443) --- .asf.yaml | 8 -- .github/dependabot.yaml | 8 +- .github/generate-email.sh | 25 ++--- .github/workflows/build.yaml | 23 ++-- .github/workflows/codeql-analysis.yml | 39 ------- .github/workflows/deploy-site.yaml | 95 +++++++++++++++++ .github/workflows/merge-dependabot.yaml | 4 +- .github/workflows/scorecards-analysis.yml | 38 ------- .gitignore | 4 + antora-playbook.yaml | 117 +++++++++++++++++++++ package.json | 7 ++ pom.xml | 17 ++- src/changelog/.2.x.x/antora.xml | 8 ++ .../.2.x.x/update_apache_logging_parent.xml | 8 -- .../update_org_apache_logging_log4j_log4j_core.xml | 4 +- .../update_org_apache_logging_logging_parent.xml | 7 +- src/changelog/.changelog.adoc.ftl | 1 + src/changelog/.index.adoc.ftl | 9 +- src/changelog/2.21.0/.release.xml | 22 +--- src/changelog/2.21.0/add-repository.xml | 4 +- src/changelog/2.22.0/.release.xml | 22 +--- src/changelog/2.22.0/add-osgi-jpms.xml | 4 +- src/changelog/2.22.0/add-sbom.xml | 20 +--- src/changelog/2.22.0/add-site.xml | 4 +- src/changelog/2.22.0/bump-log4j.xml | 4 +- src/changelog/2.22.0/bump-logging-parent.xml | 4 +- src/changelog/2.22.0/fix-group-id.xml | 4 +- .../com/sun/tools/jconsole/JConsoleContext.java | 2 +- .../log4j/jmx/gui/ClientGuiJConsolePlugin.java | 3 + .../apache/logging/log4j/jmx/gui/package-info.java | 2 +- .../services/com.sun.tools.jconsole.JConsolePlugin | 16 --- src/site/_constants.adoc | 42 -------- src/site/_constants.tmpl.adoc | 42 -------- src/site/_release-notes.adoc | 41 -------- src/site/_release-notes/_2.21.0.adoc | 46 -------- src/site/_release-notes/_2.22.0.adoc | 57 ---------- src/site/_release-notes/_2.x.x.adoc | 48 --------- src/site/antora/antora.tmpl.yml | 50 +++++++++ src/site/antora/antora.yml | 50 +++++++++ .../ROOT/images}/jmx-jconsole-editconfig.png | Bin .../ROOT/images}/jmx-jconsole-statuslogger.png | Bin .../ROOT/images}/jmx-standalone-editconfig.png | Bin .../ROOT/images}/jmx-standalone-statuslogger.png | Bin src/site/antora/modules/ROOT/nav.adoc | 22 ++++ .../antora/modules/ROOT/pages/development.adoc | 44 ++++++++ .../modules/ROOT/pages/index.adoc} | 4 +- .../antora/modules/ROOT/pages/release-notes.adoc | 21 ++++ src/site/index.adoc | 92 ---------------- 48 files changed, 497 insertions(+), 595 deletions(-) diff --git a/.asf.yaml b/.asf.yaml index bbdb002..25313f4 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -17,14 +17,6 @@ # `.asf.yaml` documentation: https://cwiki.apache.org/confluence/display/INFRA/Git+-+.asf.yaml+features -notifications: - # GitHub already provides notifications for PRs and issues. - # Please don't duplicate that noise here! - commits: commits@logging.apache.org - issues: notificati...@logging.apache.org - pullrequests: notificati...@logging.apache.org - pullrequests_bot_dependabot: rob...@logging.apache.org - github: description: Swing-based client for remotely editing the Log4j configuration and remotely monitoring `StatusLogger` output diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml index 77f107e..691844d 100644 --- a/.github/dependabot.yaml +++ b/.github/dependabot.yaml @@ -17,8 +17,7 @@ version: 2 -# Add Maven Central explicitly to work around: -# https://github.com/dependabot/dependabot-core/issues/8329 +# Fix the Maven Central to the ASF repository to work around: https://github.com/dependabot/dependabot-core/issues/8329 registries: maven-central: type: maven-repository @@ -38,3 +37,8 @@ updates: directory: "/" schedule: interval: weekly + + - package-ecosystem: npm + directory: "/" + schedule: + interval: daily diff --git a/.github/generate-email.sh b/.github/generate-email.sh index 8fcb46b..29741c8 100755 --- a/.github/generate-email.sh +++ b/.github/generate-email.sh @@ -16,10 +16,6 @@ # limitations under the License. # -# Enable strict mode -set -euo pipefail -IFS=$'\n\t' - SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &> /dev/null && pwd) stderr() { @@ -45,7 +41,7 @@ PROJECT_VERSION="$2" COMMIT_ID="$3" # Check release notes file -RELEASE_NOTES_FILE="$SCRIPT_DIR/../src/site/_release-notes/_$PROJECT_VERSION.adoc" +RELEASE_NOTES_FILE="$SCRIPT_DIR/../target/generated-site/antora/modules/ROOT/pages/_release-notes/$PROJECT_VERSION.adoc" [ -f "$RELEASE_NOTES_FILE" ] || { stderr "Couldn't find release notes file: $RELEASE_NOTES_FILE" exit 1 @@ -69,11 +65,11 @@ case $1 in vote) cat <<EOF To: d...@logging.apache.org -Title: [VOTE] Release $PROJECT_NAME $PROJECT_VERSION +Title: [VOTE] Release $PROJECT_NAME \`$PROJECT_VERSION\` -This is a vote to release the $PROJECT_NAME $PROJECT_VERSION. +This is a vote to release the $PROJECT_NAME \`$PROJECT_VERSION\`. -Website: $PROJECT_STAGING_SITE +Website: $PROJECT_STAGING_SITE-$PROJECT_VERSION GitHub: $PROJECT_REPO Commit: $COMMIT_ID Distribution: $PROJECT_DIST_DIR @@ -91,32 +87,31 @@ everyone to test the release, but only the Logging Services PMC votes are officially counted. At least 3 +1 votes and more positive than negative votes are required. -=== Review kit +== Review kit The minimum set of steps needed to review the uploaded distribution files in the Subversion repository can be summarized as follows: $(dump_review_kit) -=== Release notes - -$(dump_release_notes) +== Release Notes EOF + dump_release_notes ;; announce) cat <<EOF To: log4j-u...@logging.apache.org, d...@logging.apache.org -Title: [ANNOUNCE] $PROJECT_NAME $PROJECT_VERSION released +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 a Swing-based client for remotely editing the Log4j configuration and remotely monitoring \`StatusLogger\` output. It can be run as a standalone application or as a JConsole plugin. [1] $PROJECT_SITE -=== Release Notes +== Release Notes EOF dump_release_notes ;; diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 5d2cf2b..2502ca4 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -32,38 +32,34 @@ on: - "**.md" - "**.txt" -# If the branch is 'main' run once per commit. -# If the branch is 'release/*' allow only one concurrent run. -concurrency: - group: ${{ github.ref_name == 'main' && github.ref || github.ref_name }} - cancel-in-progress: true - permissions: read-all jobs: build: if: github.actor != 'dependabot[bot]' - uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/10.6.0 + uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/11.0.0 + with: + site-enabled: true deploy-snapshot: needs: build if: github.repository == 'apache/logging-log4j-jmx-gui' && github.ref == 'refs/heads/main' - uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@rel/10.6.0 + uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@rel/11.0.0 # Secrets for deployments secrets: - NEXUS_USER: ${{ secrets.NEXUS_USER }} - NEXUS_PW: ${{ secrets.NEXUS_PW }} + NEXUS_USERNAME: ${{ secrets.NEXUS_USER }} + NEXUS_PASSWORD: ${{ secrets.NEXUS_PW }} deploy-release: needs: build if: github.repository == 'apache/logging-log4j-jmx-gui' && startsWith(github.ref_name, 'release/') - uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@rel/10.6.0 + uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@rel/11.0.0 # Secrets for deployments secrets: GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }} - LOGGING_STAGE_DEPLOYER_USER: ${{ secrets.LOGGING_STAGE_DEPLOYER_USER }} - LOGGING_STAGE_DEPLOYER_PW: ${{ secrets.LOGGING_STAGE_DEPLOYER_PW }} + NEXUS_USERNAME: ${{ secrets.LOGGING_STAGE_DEPLOYER_USER }} + NEXUS_PASSWORD: ${{ secrets.LOGGING_STAGE_DEPLOYER_PW }} SVN_USERNAME: ${{ secrets.LOGGING_SVN_DEV_USERNAME }} SVN_PASSWORD: ${{ secrets.LOGGING_SVN_DEV_PASSWORD }} # Write permissions to allow the Maven `revision` property update, changelog release, etc. @@ -71,4 +67,3 @@ jobs: contents: write with: project-id: log4j-jmx-gui - site-enabled: true diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml deleted file mode 100644 index c51e4cf..0000000 --- a/.github/workflows/codeql-analysis.yml +++ /dev/null @@ -1,39 +0,0 @@ -# -# 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: codeql-analysis - -on: - push: - branches: [ main ] - pull_request: - # The branches below must be a subset of the branches provided in `on.push.branches` - branches: [ main ] - schedule: - - cron: '32 12 * * 5' - -permissions: read-all - -jobs: - - analyze: - uses: apache/logging-parent/.github/workflows/codeql-analysis-reusable.yaml@rel/10.6.0 - # Permissions required to publish Security Alerts - permissions: - actions: read - contents: read - security-events: write diff --git a/.github/workflows/deploy-site.yaml b/.github/workflows/deploy-site.yaml new file mode 100644 index 0000000..c9990dd --- /dev/null +++ b/.github/workflows/deploy-site.yaml @@ -0,0 +1,95 @@ +# +# 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: deploy-site + +on: + push: + branches: + - "main" + - "main-site-pro" + - "release/*" + paths-ignore: + - "**.md" + - "**.txt" + +permissions: read-all + +jobs: + + deploy-site-stg: + if: github.repository == 'apache/logging-log4j-jmx-gui' && github.ref_name == 'main' + uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.0.0 + # Secrets for committing the generated site + secrets: + GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }} + # Write permissions for committing the generated site + permissions: + contents: write + with: + asf-yaml-content: | + staging: + profile: ~ + whoami: ${{ github.ref_name }}-site-stg-out + subdir: content/log4j/jmx-gui + target-branch: ${{ github.ref_name }}-site-stg-out + + deploy-site-pro: + if: github.repository == 'apache/logging-log4j-jmx-gui' && github.ref_name == 'main-site-pro' + uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.0.0 + # Secrets for committing the generated site + secrets: + GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }} + # Write permissions for committing the generated site + permissions: + contents: write + with: + asf-yaml-content: | + publish: + profile: ~ + whoami: ${{ github.ref_name }}-out + subdir: content/log4j/jmx-gui + target-branch: ${{ github.ref_name }}-out + + export-version: + if: github.repository == 'apache/logging-log4j-jmx-gui' && startsWith(github.ref_name, 'release/') + runs-on: ubuntu-latest + outputs: + version: ${{ steps.export-version.outputs.version }} + steps: + - name: Export version + id: export-version + run: | + version=$(echo "${{ github.ref_name }}" | sed 's/^release\///') + echo "version=$version" >> "$GITHUB_OUTPUT" + + deploy-site-rel: + needs: export-version + uses: apache/logging-parent/.github/workflows/deploy-site-reusable.yaml@rel/11.0.0 + # Secrets for committing the generated site + secrets: + GPG_SECRET_KEY: ${{ secrets.LOGGING_GPG_SECRET_KEY }} + # Write permissions for committing the generated site + permissions: + contents: write + with: + asf-yaml-content: | + staging: + profile: ~ + whoami: ${{ github.ref_name }}-site-stg-out + subdir: content/log4j/jmx-gui-${{ needs.export-version.outputs.version }} + target-branch: ${{ github.ref_name }}-site-stg-out diff --git a/.github/workflows/merge-dependabot.yaml b/.github/workflows/merge-dependabot.yaml index 3c7c528..4dd8f73 100644 --- a/.github/workflows/merge-dependabot.yaml +++ b/.github/workflows/merge-dependabot.yaml @@ -30,11 +30,11 @@ jobs: build: if: github.repository == 'apache/logging-log4j-jmx-gui' && github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]' - uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/10.6.0 + uses: apache/logging-parent/.github/workflows/build-reusable.yaml@rel/11.0.0 merge-dependabot: needs: build - uses: apache/logging-parent/.github/workflows/merge-dependabot-reusable.yaml@rel/10.6.0 + uses: apache/logging-parent/.github/workflows/merge-dependabot-reusable.yaml@rel/11.0.0 permissions: contents: write # to push changelog commits pull-requests: write # to close the PR diff --git a/.github/workflows/scorecards-analysis.yml b/.github/workflows/scorecards-analysis.yml deleted file mode 100644 index 860bbd3..0000000 --- a/.github/workflows/scorecards-analysis.yml +++ /dev/null @@ -1,38 +0,0 @@ -# -# 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: scorecards-analysis - -on: - branch_protection_rule: - schedule: - - cron: "30 1 * * 6" - push: - branches: [ main ] - -permissions: read-all - -jobs: - - analysis: - uses: apache/logging-parent/.github/workflows/scorecards-analysis-reusable.yaml@rel/10.6.0 - permissions: - # Needed to upload the results to the code-scanning dashboard. - security-events: write - actions: read - id-token: write # This is required for requesting the JWT - contents: read # This is required for actions/checkout diff --git a/.gitignore b/.gitignore index cc6cc57..db050d7 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,7 @@ target/ .project .classpath .settings/ +# Node +node +node_modules +package-lock.json diff --git a/antora-playbook.yaml b/antora-playbook.yaml new file mode 100644 index 0000000..e0c6c6a --- /dev/null +++ b/antora-playbook.yaml @@ -0,0 +1,117 @@ +# +# 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. +# + +site: + title: Apache Log4j JMX GUI + url: "https://logging.apache.org/log4j/jmx-gui" + start_page: "ROOT::index.adoc" + +content: + sources: + - url: . + branches: HEAD + start_paths: + - target/generated-site/antora + edit_url: + +asciidoc: + extensions: + - "@asciidoctor/tabs" + +ui: + + bundle: + url: "https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable" + snapshot: true + + # Template files: https://github.com/asciidoctor/asciidoctor-docs-ui/blob/main/src + # Template variables: https://docs.antora.org/antora-ui-default/templates + supplemental_files: + + # Add `@asciidoctor/tabs` extension styles + - path: css/vendor/tabs.css + contents: ./node_modules/@asciidoctor/tabs/dist/css/tabs.css + + # Add `@asciidoctor/tabs` extension scripts + - path: js/vendor/tabs.js + contents: ./node_modules/@asciidoctor/tabs/dist/js/tabs.js + + - path: partials/footer-scripts.hbs + contents: | + <script id="site-script" src="{{{uiRootPath}}}/js/site.js" data-ui-root-path="{{{uiRootPath}}}"></script> + <script async src="{{{uiRootPath}}}/js/vendor/highlight.js"></script> + <!-- `@asciidoctor/tabs` extension scripts --> + <script async src="{{{uiRootPath}}}/js/vendor/tabs.js"></script> + {{#if env.SITE_SEARCH_PROVIDER}} + {{> search-scripts}} + {{/if}} + + - path: partials/head-styles.hbs + contents: | + <link rel="stylesheet" href="{{{uiRootPath}}}/css/site.css"> + <link rel="icon" href="{{{uiRootPath}}}/../_images/favicon.ico" type="image/x-icon"> + <!-- `@asciidoctor/tabs` extension styles --> + <link rel="stylesheet" href="{{{uiRootPath}}}/css/vendor/tabs.css"> + <style> + /* `page-toclevels` greater than 4 are not supported by Antora UI, patching it: */ + .toc .toc-menu li[data-level="4"] a { + padding-left: 2.75rem + } + /* Replace the default highlight.js color for strings from red to green: */ + .hljs-string { + color: #0f8532; + } + </style> + + - path: partials/header-content.hbs + contents: | + <header class="header"> + <nav class="navbar"> + <div class="navbar-brand"> + <span class="navbar-item title">{{site.title}}</span> + </div> + <div id="topbar-nav" class="navbar-menu"> + <div class="navbar-end"> + <a class="navbar-item" href="https://logging.apache.org">a subproject of <strong>Apache Logging Services</strong></a> + </div> + </div> + </nav> + </header> + + - path: partials/footer-content.hbs + contents: | + <footer class="footer"> + <p> + Copyright © 1999-{{{year}}} <a href="https://www.apache.org/">The Apache Software Foundation</a>. + Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache Software License, Version 2.0</a>. + Please read our <a href="https://privacy.apache.org/policies/privacy-policy-public.html">privacy policy</a>. + </p> + <p> + Apache, Log4j, and the Apache feather logo are trademarks or registered trademarks of The Apache Software Foundation. + Oracle and Java are registered trademarks of Oracle and/or its affiliates. + Other names may be trademarks of their respective owners. + </p> + </footer> + + # Disable component version selector + - path: partials/nav-explore.hbs + contents: "" + + # Fix the `Edit this page` link + - path: partials/edit-this-page.hbs + contents: | + <div class="edit-this-page"><a href="https://github.com/apache/logging-log4j-jmx-gui/edit/main/src/site/antora/modules/{{page.module}}/pages/{{page.relativeSrcPath}}">Edit this Page</a></div> diff --git a/package.json b/package.json new file mode 100644 index 0000000..686f9f3 --- /dev/null +++ b/package.json @@ -0,0 +1,7 @@ +{ + "dependencies": { + "@antora/cli": "^3.2.0-alpha.4", + "@antora/site-generator-default": "^3.2.0-alpha.4", + "@asciidoctor/tabs": "^1.0.0-beta.6" + } +} diff --git a/pom.xml b/pom.xml index 58060b1..7d895eb 100644 --- a/pom.xml +++ b/pom.xml @@ -22,7 +22,7 @@ <parent> <groupId>org.apache.logging</groupId> <artifactId>logging-parent</artifactId> - <version>10.6.0</version> + <version>11.0.0</version> </parent> <groupId>org.apache.logging.log4j</groupId> @@ -130,7 +130,7 @@ </ciManagement> <distributionManagement> - <downloadUrl>${scm.url}</downloadUrl> + <downloadUrl>https://logging.apache.org/download.html</downloadUrl> </distributionManagement> <properties> @@ -147,11 +147,12 @@ Hence, *DO NOT MANUALLY EDIT THIS VALUE*! --> <project.build.outputTimestamp>2023-11-15T15:33:35Z</project.build.outputTimestamp> - <!-- Additional manifest entries --> - <Class-Path>log4j-api-2.21.0.jar log4j-core-2.21.0.jar</Class-Path> - <!-- dependency versions --> <log4j.version>2.23.1</log4j.version> + <nashorn.version>15.4</nashorn.version> + + <!-- Additional manifest entries --> + <Class-Path>log4j-api-${log4j.version}.jar log4j-core-${log4j.version}.jar</Class-Path> </properties> @@ -187,6 +188,12 @@ <version>${log4j.version}</version> </dependency> + <dependency> + <groupId>org.openjdk.nashorn</groupId> + <artifactId>nashorn-core</artifactId> + <version>${nashorn.version}</version> + </dependency> + </dependencies> <build> diff --git a/src/changelog/.2.x.x/antora.xml b/src/changelog/.2.x.x/antora.xml new file mode 100644 index 0000000..7aacd0a --- /dev/null +++ b/src/changelog/.2.x.x/antora.xml @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8"?> +<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" + type="changed"> + <issue id="apache/logging-log4j2#2443" link="https://github.com/apache/logging-log4j2/pull/2443"/> + <description format="asciidoc">Website is migrated to Antora</description> +</entry> diff --git a/src/changelog/.2.x.x/update_apache_logging_parent.xml b/src/changelog/.2.x.x/update_apache_logging_parent.xml deleted file mode 100644 index 56e1a79..0000000 --- a/src/changelog/.2.x.x/update_apache_logging_parent.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.3.xsd" - type="updated"> - <issue id="6" link="https://github.com/apache/logging-log4j-jmx-gui/pull/6"/> - <description format="asciidoc">Update `apache/logging-parent` to version ``</description> -</entry> diff --git a/src/changelog/.2.x.x/update_org_apache_logging_log4j_log4j_core.xml b/src/changelog/.2.x.x/update_org_apache_logging_log4j_log4j_core.xml index 4267626..0466e10 100644 --- a/src/changelog/.2.x.x/update_org_apache_logging_log4j_log4j_core.xml +++ b/src/changelog/.2.x.x/update_org_apache_logging_log4j_log4j_core.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.3.xsd" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="updated"> <issue id="10" link="https://github.com/apache/logging-log4j-jmx-gui/pull/10"/> <description format="asciidoc">Update `org.apache.logging.log4j:log4j-core` to version `2.23.1`</description> diff --git a/src/changelog/.2.x.x/update_org_apache_logging_logging_parent.xml b/src/changelog/.2.x.x/update_org_apache_logging_logging_parent.xml index ebc5674..d674691 100644 --- a/src/changelog/.2.x.x/update_org_apache_logging_logging_parent.xml +++ b/src/changelog/.2.x.x/update_org_apache_logging_logging_parent.xml @@ -1,8 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.3.xsd" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="updated"> - <issue id="7" link="https://github.com/apache/logging-log4j-jmx-gui/pull/7"/> - <description format="asciidoc">Update `org.apache.logging:logging-parent` to version `10.6.0`</description> + <description format="asciidoc">Update `org.apache.logging:logging-parent` to version `11.0.0`</description> </entry> diff --git a/src/changelog/.changelog.adoc.ftl b/src/changelog/.changelog.adoc.ftl index 5c8e30c..00a9a1a 100644 --- a/src/changelog/.changelog.adoc.ftl +++ b/src/changelog/.changelog.adoc.ftl @@ -17,6 +17,7 @@ <#if entriesByType?size gt 0> <#list entriesByType as entryType, entries> +[#release-notes-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}-${entryType?lower_case}] === ${entryType?capitalize} <#list entries as entry> diff --git a/src/changelog/.index.adoc.ftl b/src/changelog/.index.adoc.ftl index 05b7679..24c1ef3 100644 --- a/src/changelog/.index.adoc.ftl +++ b/src/changelog/.index.adoc.ftl @@ -33,9 +33,12 @@ 3. Commit both `.index.adoc.ftl` and the generated `.index.adoc` //// -[#release-notes] -= Release Notes +// Release notes index does not look nice with a deep sectioning, override it: +:page-toclevels: 1 +[#release-notes] += Release notes <#list releases as release><#if release.changelogEntryCount gt 0> -include::_release-notes/_${release.version}.adoc[] + +include::_release-notes/${release.version}.adoc[] </#if></#list> diff --git a/src/changelog/2.21.0/.release.xml b/src/changelog/2.21.0/.release.xml index a922340..c820e7b 100644 --- a/src/changelog/2.21.0/.release.xml +++ b/src/changelog/2.21.0/.release.xml @@ -1,21 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- - ~ 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. - --> -<release xmlns="http://logging.apache.org/log4j/changelog" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd" +<release xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" date="2023-09-15" version="2.21.0"/> diff --git a/src/changelog/2.21.0/add-repository.xml b/src/changelog/2.21.0/add-repository.xml index 34342ce..c96a40b 100644 --- a/src/changelog/2.21.0/add-repository.xml +++ b/src/changelog/2.21.0/add-repository.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="added"> <description format="asciidoc">Project is moved to a new https://github.com/apache/logging-log4j-jmx-gui[repository] with its own release cycle</description> </entry> diff --git a/src/changelog/2.22.0/.release.xml b/src/changelog/2.22.0/.release.xml index 505d2b3..172c0ae 100644 --- a/src/changelog/2.22.0/.release.xml +++ b/src/changelog/2.22.0/.release.xml @@ -1,21 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- - ~ 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. - --> -<release xmlns="http://logging.apache.org/log4j/changelog" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd" +<release xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" date="2023-11-15" version="2.22.0"/> diff --git a/src/changelog/2.22.0/add-osgi-jpms.xml b/src/changelog/2.22.0/add-osgi-jpms.xml index 2f06ef7..96bc980 100644 --- a/src/changelog/2.22.0/add-osgi-jpms.xml +++ b/src/changelog/2.22.0/add-osgi-jpms.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="changed"> <description format="asciidoc"> Add OSGi and JPMS descriptors diff --git a/src/changelog/2.22.0/add-sbom.xml b/src/changelog/2.22.0/add-sbom.xml index 2e288fc..48da6ee 100644 --- a/src/changelog/2.22.0/add-sbom.xml +++ b/src/changelog/2.22.0/add-sbom.xml @@ -1,23 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- - ~ 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. - --> <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="added"> <description format="asciidoc">Started generating CycloneDX SBOM with the recent update of `logging-parent` to version `10.4.0`</description> </entry> diff --git a/src/changelog/2.22.0/add-site.xml b/src/changelog/2.22.0/add-site.xml index 6307e85..9c8dfdf 100644 --- a/src/changelog/2.22.0/add-site.xml +++ b/src/changelog/2.22.0/add-site.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="added"> <description format="asciidoc"> Publish https://logging.apache.org/log4j/jmx-gui[the website] diff --git a/src/changelog/2.22.0/bump-log4j.xml b/src/changelog/2.22.0/bump-log4j.xml index 89ef25a..003b0ee 100644 --- a/src/changelog/2.22.0/bump-log4j.xml +++ b/src/changelog/2.22.0/bump-log4j.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="changed"> <description format="asciidoc"> Update `log4j-core` to version `2.21.1` diff --git a/src/changelog/2.22.0/bump-logging-parent.xml b/src/changelog/2.22.0/bump-logging-parent.xml index adec0e7..96fedc1 100644 --- a/src/changelog/2.22.0/bump-logging-parent.xml +++ b/src/changelog/2.22.0/bump-logging-parent.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="changed"> <description format="asciidoc"> Update `logging-parent` to version `10.4.0` diff --git a/src/changelog/2.22.0/fix-group-id.xml b/src/changelog/2.22.0/fix-group-id.xml index 4bcfd00..fc733b7 100644 --- a/src/changelog/2.22.0/fix-group-id.xml +++ b/src/changelog/2.22.0/fix-group-id.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns="http://logging.apache.org/log4j/changelog" - xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.2.xsd" + xmlns="https://logging.apache.org/xml/ns" + xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd" type="fixed"> <description format="asciidoc"> Restore the original Maven `groupId`: `org.apache.logging.log4j` diff --git a/src/main/java/com/sun/tools/jconsole/JConsoleContext.java b/src/main/java/com/sun/tools/jconsole/JConsoleContext.java index 57b87b6..755433a 100644 --- a/src/main/java/com/sun/tools/jconsole/JConsoleContext.java +++ b/src/main/java/com/sun/tools/jconsole/JConsoleContext.java @@ -23,5 +23,5 @@ import javax.management.MBeanServerConnection; */ public interface JConsoleContext { - public MBeanServerConnection getMBeanServerConnection(); + MBeanServerConnection getMBeanServerConnection(); } diff --git a/src/main/java/org/apache/logging/log4j/jmx/gui/ClientGuiJConsolePlugin.java b/src/main/java/org/apache/logging/log4j/jmx/gui/ClientGuiJConsolePlugin.java index 4009f42..f24229f 100644 --- a/src/main/java/org/apache/logging/log4j/jmx/gui/ClientGuiJConsolePlugin.java +++ b/src/main/java/org/apache/logging/log4j/jmx/gui/ClientGuiJConsolePlugin.java @@ -16,6 +16,8 @@ */ package org.apache.logging.log4j.jmx.gui; +import aQute.bnd.annotation.Resolution; +import aQute.bnd.annotation.spi.ServiceProvider; import com.sun.tools.jconsole.JConsolePlugin; import java.util.HashMap; import java.util.Map; @@ -25,6 +27,7 @@ import javax.swing.SwingWorker; /** * Adapts the {@code ClientGui} to the {@code JConsolePlugin} API. */ +@ServiceProvider(value = JConsolePlugin.class, resolution = Resolution.MANDATORY) public class ClientGuiJConsolePlugin extends JConsolePlugin { @Override diff --git a/src/main/java/org/apache/logging/log4j/jmx/gui/package-info.java b/src/main/java/org/apache/logging/log4j/jmx/gui/package-info.java index f5f40e0..3dab91b 100644 --- a/src/main/java/org/apache/logging/log4j/jmx/gui/package-info.java +++ b/src/main/java/org/apache/logging/log4j/jmx/gui/package-info.java @@ -19,7 +19,7 @@ * Log4j 2.0 JMX GUI. */ @Export -@Version("2.20.1") +@Version("2.20.2") package org.apache.logging.log4j.jmx.gui; import org.osgi.annotation.bundle.Export; diff --git a/src/main/resources/META-INF/services/com.sun.tools.jconsole.JConsolePlugin b/src/main/resources/META-INF/services/com.sun.tools.jconsole.JConsolePlugin deleted file mode 100644 index 44e2aab..0000000 --- a/src/main/resources/META-INF/services/com.sun.tools.jconsole.JConsolePlugin +++ /dev/null @@ -1,16 +0,0 @@ -# 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. -# -org.apache.logging.log4j.jmx.gui.ClientGuiJConsolePlugin diff --git a/src/site/_constants.adoc b/src/site/_constants.adoc deleted file mode 100644 index b349316..0000000 --- a/src/site/_constants.adoc +++ /dev/null @@ -1,42 +0,0 @@ -//// - 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. -//// - -//// - ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██ - ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██ - ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ - ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ - ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██ - - IF THIS FILE DOESN'T HAVE A `.tmpl.adoc` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT! - - `_constants.adoc` is auto-generated from `_constants.tmpl.adoc`. - Auto-generation happens during `process-sources` phase of Maven. - Hence, you must always - - 1. Edit `_constants.tmpl.adoc` - 2. Run `./mvnw process-sources` - 3. Commit both `_constants.tmpl.adoc` and the generated `_constants.adoc` -//// - -:project-github-url: https://github.com/apache/logging-log4j-jmx-gui -:project-version: 2.23.0-SNAPSHOT -:project-name: Log4j JMX GUI -:project-id: log4j-jmx-gui -:java-target-version: 8 -:java-compiler-version: [17,18) -:log4j-version: 2.23.1 diff --git a/src/site/_constants.tmpl.adoc b/src/site/_constants.tmpl.adoc deleted file mode 100644 index a46b732..0000000 --- a/src/site/_constants.tmpl.adoc +++ /dev/null @@ -1,42 +0,0 @@ -//// - 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. -//// - -//// - ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██ - ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██ - ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ - ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ - ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██ - - IF THIS FILE DOESN'T HAVE A `.tmpl.adoc` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT! - - `_constants.adoc` is auto-generated from `_constants.tmpl.adoc`. - Auto-generation happens during `process-sources` phase of Maven. - Hence, you must always - - 1. Edit `_constants.tmpl.adoc` - 2. Run `./mvnw process-sources` - 3. Commit both `_constants.tmpl.adoc` and the generated `_constants.adoc` -//// - -:project-github-url: ${scm.url} -:project-version: ${project.version} -:project-name: Log4j JMX GUI -:project-id: log4j-jmx-gui -:java-target-version: ${maven.compiler.target} -:java-compiler-version: ${minimalJavaBuildVersion} -:log4j-version: ${log4j.version} diff --git a/src/site/_release-notes.adoc b/src/site/_release-notes.adoc deleted file mode 100644 index 8964666..0000000 --- a/src/site/_release-notes.adoc +++ /dev/null @@ -1,41 +0,0 @@ -//// - 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. -//// - -//// - ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██ - ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██ - ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ - ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ - ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██ - - IF THIS FILE IS CALLED `index.adoc`, IT IS AUTO-GENERATED, DO NOT EDIT IT! - - Release notes `index.adoc` is generated from `src/changelog/.index.adoc.ftl`. - Auto-generation happens during `generate-sources` phase of Maven. - Hence, you must always - - 1. Edit `.index.adoc.ftl` - 2. Run `./mvnw generate-sources` - 3. Commit both `.index.adoc.ftl` and the generated `.index.adoc` -//// - -[#release-notes] -= Release Notes - -include::_release-notes/_2.x.x.adoc[] -include::_release-notes/_2.22.0.adoc[] -include::_release-notes/_2.21.0.adoc[] diff --git a/src/site/_release-notes/_2.21.0.adoc b/src/site/_release-notes/_2.21.0.adoc deleted file mode 100644 index 617adff..0000000 --- a/src/site/_release-notes/_2.21.0.adoc +++ /dev/null @@ -1,46 +0,0 @@ -//// - 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 - - 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. -//// - -//// - ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██ - ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██ - ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ - ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ - ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██ - - IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT! - - Version-specific release notes (`7.8.0.adoc`, etc.) are generated from `src/changelog/*/.release-notes.adoc.ftl`. - Auto-generation happens during `generate-sources` phase of Maven. - Hence, you must always - - 1. Find and edit the associated `.release-notes.adoc.ftl` - 2. Run `./mvnw generate-sources` - 3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc` -//// - -[#release-notes-2-21-0] -== 2.21.0 - -Release date:: 2023-09-15 - -This marks the first release where the Log4j JMX GUI is released separately from the Log4j itself. - - -=== Added - -* Project is moved to a new https://github.com/apache/logging-log4j-jmx-gui[repository] with its own release cycle diff --git a/src/site/_release-notes/_2.22.0.adoc b/src/site/_release-notes/_2.22.0.adoc deleted file mode 100644 index 64026d8..0000000 --- a/src/site/_release-notes/_2.22.0.adoc +++ /dev/null @@ -1,57 +0,0 @@ -//// - 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 - - 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. -//// - -//// - ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██ - ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██ - ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ - ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ - ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██ - - IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT! - - Version-specific release notes (`7.8.0.adoc`, etc.) are generated from `src/changelog/*/.release-notes.adoc.ftl`. - Auto-generation happens during `generate-sources` phase of Maven. - Hence, you must always - - 1. Find and edit the associated `.release-notes.adoc.ftl` - 2. Run `./mvnw generate-sources` - 3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc` -//// - -[#release-notes-2-22-0] -== 2.22.0 - -Release date:: 2023-11-15 - -This release contains minor improvements. - - -=== Added - -* Started generating CycloneDX SBOM with the recent update of `logging-parent` to version `10.4.0` -* Publish https://logging.apache.org/log4j/jmx-gui[the website] - -=== Changed - -* Add OSGi and JPMS descriptors -* Update `log4j-core` to version `2.21.1` -* Update `logging-parent` to version `10.4.0` - -=== Fixed - -* Restore the original Maven `groupId`: `org.apache.logging.log4j` diff --git a/src/site/_release-notes/_2.x.x.adoc b/src/site/_release-notes/_2.x.x.adoc deleted file mode 100644 index 0d17068..0000000 --- a/src/site/_release-notes/_2.x.x.adoc +++ /dev/null @@ -1,48 +0,0 @@ -//// - 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 - - 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. -//// - -//// - ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██ - ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██ - ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ - ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ - ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██ - - IF THIS FILE DOESN'T HAVE A `.ftl` SUFFIX, IT IS AUTO-GENERATED, DO NOT EDIT IT! - - Version-specific release notes (`7.8.0.adoc`, etc.) are generated from `src/changelog/*/.release-notes.adoc.ftl`. - Auto-generation happens during `generate-sources` phase of Maven. - Hence, you must always - - 1. Find and edit the associated `.release-notes.adoc.ftl` - 2. Run `./mvnw generate-sources` - 3. Commit both `.release-notes.adoc.ftl` and the generated `7.8.0.adoc` -//// - -[#release-notes-2-x-x] -== 2.x.x - - - -This release contains minor improvements. - - -=== Updated - -* Update `apache/logging-parent` to version `` (https://github.com/apache/logging-log4j-jmx-gui/pull/6[6]) -* Update `org.apache.logging.log4j:log4j-core` to version `2.23.1` (https://github.com/apache/logging-log4j-jmx-gui/pull/10[10]) -* Update `org.apache.logging:logging-parent` to version `10.6.0` (https://github.com/apache/logging-log4j-jmx-gui/pull/7[7]) diff --git a/src/site/antora/antora.tmpl.yml b/src/site/antora/antora.tmpl.yml new file mode 100644 index 0000000..b682963 --- /dev/null +++ b/src/site/antora/antora.tmpl.yml @@ -0,0 +1,50 @@ +# +# 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. +# + +# +# ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██ +# ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██ +# ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ +# ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ +# ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██ +# +# THIS FILE IS USED AS A TEMPLATE TO AUTO-GENERATE `antora.yml`! +# +# The actual `antora.yml` that is used in `target/generated-site/antora` is auto-generated from `.antora.yml`. +# Auto-generation happens during `pre-site` phase of Maven. +# Hence, you must always +# +# 1. Edit `.antora.yml` +# 2. Edit `antora.yml` to match the fields in `.antora.yml` and fill Maven property placeholders with dummy values +# + +name: ROOT +title: Home +version: ~ +start_page: index.adoc +asciidoc: + attributes: + project-github-url: "${scm.url}" + project-version: "${project.version}" + project-name: "Log4j JMX GUI" + project-id: "log4j-jmx-gui" + java-target-version: "${maven.compiler.target}" + java-compiler-version: "${minimalJavaBuildVersion}" + log4j-version: "${log4j.version}" + logging-services-url: "https://logging.apache.org" +nav: + - modules/ROOT/nav.adoc diff --git a/src/site/antora/antora.yml b/src/site/antora/antora.yml new file mode 100644 index 0000000..40b3101 --- /dev/null +++ b/src/site/antora/antora.yml @@ -0,0 +1,50 @@ +# +# 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. +# + +# +# ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██ +# ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██ +# ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ +# ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ +# ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██ +# +# THIS FILE IS A STUB! +# +# The actual `antora.yml` that is used in `target/generated-site/antora` is auto-generated from `antora.tmpl.yml`. +# Auto-generation happens during `pre-site` phase of Maven. +# Hence, you must always +# +# 1. Edit `antora.tmpl.yml` +# 2. Edit `antora.yml` to match the fields in `antora.tmpl.yml` and fill Maven property placeholders with dummy values +# + +name: ROOT +title: Home +version: ~ +start_page: index.adoc +asciidoc: + attributes: + project-github-url: "https://github.com/apache/logging-log4j-jmx-gui" + project-version: "1.2.3" + project-name: "Log4j JMX GUI" + project-id: "log4j-jmx-gui" + java-target-version: "8" + java-compiler-version: "[17,18)" + log4j-version: "2.3.4" + logging-services-url: "https://logging.apache.org" +nav: + - modules/ROOT/nav.adoc diff --git a/src/site/jmx-jconsole-editconfig.png b/src/site/antora/modules/ROOT/images/jmx-jconsole-editconfig.png similarity index 100% rename from src/site/jmx-jconsole-editconfig.png rename to src/site/antora/modules/ROOT/images/jmx-jconsole-editconfig.png diff --git a/src/site/jmx-jconsole-statuslogger.png b/src/site/antora/modules/ROOT/images/jmx-jconsole-statuslogger.png similarity index 100% rename from src/site/jmx-jconsole-statuslogger.png rename to src/site/antora/modules/ROOT/images/jmx-jconsole-statuslogger.png diff --git a/src/site/jmx-standalone-editconfig.png b/src/site/antora/modules/ROOT/images/jmx-standalone-editconfig.png similarity index 100% rename from src/site/jmx-standalone-editconfig.png rename to src/site/antora/modules/ROOT/images/jmx-standalone-editconfig.png diff --git a/src/site/jmx-standalone-statuslogger.png b/src/site/antora/modules/ROOT/images/jmx-standalone-statuslogger.png similarity index 100% rename from src/site/jmx-standalone-statuslogger.png rename to src/site/antora/modules/ROOT/images/jmx-standalone-statuslogger.png diff --git a/src/site/antora/modules/ROOT/nav.adoc b/src/site/antora/modules/ROOT/nav.adoc new file mode 100644 index 0000000..c40ea29 --- /dev/null +++ b/src/site/antora/modules/ROOT/nav.adoc @@ -0,0 +1,22 @@ +//// + 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. +//// + +* xref:development.adoc[] +* xref:release-notes.adoc[] +* {logging-services-url}/download.html[Download] +* {logging-services-url}/support.html[Support] +* {logging-services-url}/security.html[Security] diff --git a/src/site/antora/modules/ROOT/pages/development.adoc b/src/site/antora/modules/ROOT/pages/development.adoc new file mode 100644 index 0000000..2bb1144 --- /dev/null +++ b/src/site/antora/modules/ROOT/pages/development.adoc @@ -0,0 +1,44 @@ +//// + 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. +//// + += Development + +{project-name} uses {project-github-url}[GitHub] for source code management. + +The project requires a Java compiler matching the `{java-compiler-version}` range and targets Java `{java-target-version}`. + +You can build and verify sources using: + +[source,bash] +---- +./mvnw verify +---- + +You can build and view the website as follows: + +[source,bash] +---- +./mvnw -N site +---- + +You can view the generated website with a browser by pointing it to `target/site` directory. + +[#release-instructions] +== Release instructions + +{project-name} employs the CI/CD foundation provided by the {logging-services-url}/logging-parent[`logging-parent`]. +You can simply use its release instructions. diff --git a/src/site/_manual.adoc b/src/site/antora/modules/ROOT/pages/index.adoc similarity index 97% rename from src/site/_manual.adoc rename to src/site/antora/modules/ROOT/pages/index.adoc index e899194..4f9ecef 100644 --- a/src/site/_manual.adoc +++ b/src/site/antora/modules/ROOT/pages/index.adoc @@ -18,7 +18,9 @@ :log4j-jmx-doc-url: https://logging.apache.org/log4j/2.x/manual/jmx.html :oracle-remote-monitoring-doc-url: https://docs.oracle.com/javase/8/docs/technotes/guides/management/agent.html#gdenl -The Log4j JMX GUI provides a Swing-based client for remotely editing the Log4j configuration and remotely monitoring `StatusLogger` output. += Log4j JMX GUI + +The {project-name} provides a Swing-based client for remotely editing the Log4j configuration and remotely monitoring `StatusLogger` output. It can be run as a standalone application or as a JConsole plugin. Log4j has built-in support for JMX. diff --git a/src/site/antora/modules/ROOT/pages/release-notes.adoc b/src/site/antora/modules/ROOT/pages/release-notes.adoc new file mode 100644 index 0000000..a2bfd86 --- /dev/null +++ b/src/site/antora/modules/ROOT/pages/release-notes.adoc @@ -0,0 +1,21 @@ +//// + 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. +//// + += Release notes + +This file is a stub. +Its content will be auto-generated during build. diff --git a/src/site/index.adoc b/src/site/index.adoc deleted file mode 100644 index 93e62d1..0000000 --- a/src/site/index.adoc +++ /dev/null @@ -1,92 +0,0 @@ -//// - 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. -//// - -include::_constants.adoc[] - -= Log4j JMX GUI - -include::_manual.adoc[] - -[#development] -== Development - -{project-name} uses {project-github-url}[GitHub] for source code management. - -The project requires a Java compiler matching the `{java-compiler-version}` range and targets Java `{java-target-version}`. - -You can build and verify sources using: - -[source,bash] ----- -./mvnw verify ----- - -You can build and view the website as follows: - -[source,bash] ----- -./mvnw -N site -python -m http.server -d target/site ----- - -[#distribution] -== 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/{project-id}[Distribution directory] - -See xref:#release-instructions[the release instructions] for details. - -[#cyclonedx-sbom] -=== CycloneDX Software Bill of Materials (SBOM) - -Starting with version `0.6.0`, {project-name} distributes https://cyclonedx.org/capabilities/sbom/[CyclenoDX Software Bill of Materials (SBOM)] along with each deployed artifact. -This is streamlined by `logging-parent`, see https://logging.apache.org/logging-parent/latest/#cyclonedx-sbom[its website] for details. - -[#support] -== 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] -== Security - -If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to mailto:secur...@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. - -include::_release-notes.adoc[] - -[#release-instructions] -== Release instructions - -{project-name} employs the CI/CD foundation provided by the https://logging.apache.org/logging-parent[`logging-parent`]. -You can simply use its release instructions. - -[#license] -== License - -Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. -See `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.