This is an automated email from the ASF dual-hosted git repository. vy pushed a commit to branch parent-10.1.1 in repository https://gitbox.apache.org/repos/asf/logging-log4j-transform.git
commit a5834dc1794e533ae1d9a8fbae70a56f727b5f33 Author: Volkan Yazıcı <[email protected]> AuthorDate: Mon Oct 2 15:44:19 2023 +0200 Migrate `pom.xml` to `logging-parent` version `10.1.1` --- .github/workflows/build.yaml | 34 +++++++++------- .../{build.yaml => merge-dependabot.yaml} | 39 +++++------------- .mvn/jvm.config | 2 + log4j-transform-maven-plugin/pom.xml | 12 ++---- .../pom.xml | 4 ++ log4j-transform-parent/pom.xml | 14 ------- log4j-transform-perf/pom.xml | 1 + log4j-weaver/pom.xml | 15 +++---- .../logging/log4j/weaver/log4j2/package-info.java | 20 +++++++++ .../apache/logging/log4j/weaver/package-info.java | 20 +++++++++ pom.xml | 6 ++- src/changelog/.0.x.x/.release-notes.adoc.ftl | 43 ++++++++++++++++++++ src/changelog/.0.x.x/.release-notes.md.ftl | 22 ---------- src/changelog/.0.x.x/logging-parent-update.xml | 3 +- .../{.changelog.md.ftl => .changelog.adoc.ftl} | 6 +-- src/changelog/.index.adoc.ftl | 41 +++++++++++++++++++ src/changelog/.index.md.ftl | 22 ---------- src/changelog/0.1.0/.release-notes.adoc.ftl | 43 ++++++++++++++++++++ src/changelog/0.1.0/.release-notes.md.ftl | 22 ---------- ...638_Provide_Maven_plugin_to_inline_location.xml | 2 +- ...LOG4J2-673_Maven_Shade_resource_transformer.xml | 2 +- src/site/_release-notes.adoc | 40 ++++++++++++++++++ src/site/_release-notes/_0.1.0.adoc | 47 ++++++++++++++++++++++ src/site/_release-notes/_0.x.x.adoc | 46 +++++++++++++++++++++ 24 files changed, 357 insertions(+), 149 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 9b1b20e..f8b508f 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -19,10 +19,9 @@ name: build on: push: - # Avoid workflow run for _merged_ `dependabot` PRs. - # They were (hopefully!) already tested in PR-triggered workflow. - branches-ignore: - - "dependabot/**" + branches: + - "main" + - "release/*" paths-ignore: - "**.adoc" - "**.md" @@ -38,26 +37,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-transform' && github.ref == 'refs/heads/main' + if: github.repository == 'apache/logging-log4j-transform' && 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-transform' && startsWith(github.ref, 'refs/heads/release/') + if: github.repository == 'apache/logging-log4j-transform' && 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-transform - distribution-attachment-count: 4 + project-id: log4j-transform + distribution-attachment-count: 3 + site-enabled: true diff --git a/.github/workflows/build.yaml b/.github/workflows/merge-dependabot.yaml similarity index 51% copy from .github/workflows/build.yaml copy to .github/workflows/merge-dependabot.yaml index 9b1b20e..9535e47 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/merge-dependabot.yaml @@ -15,19 +15,10 @@ # limitations under the License. # -name: build +name: merge-dependabot 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" - - "**.txt" - pull_request: + pull_request_target: paths-ignore: - "**.adoc" - "**.md" @@ -38,26 +29,14 @@ permissions: read-all jobs: build: + if: github.repository == 'apache/logging-log4j-transform' && github.event_name == 'pull_request_target' && 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-transform' && github.ref == 'refs/heads/main' - uses: apache/logging-parent/.github/workflows/deploy-snapshot-reusable.yaml@main - secrets: inherit - deploy-release: + merge-dependabot: needs: build - if: github.repository == 'apache/logging-log4j-transform' && startsWith(github.ref, 'refs/heads/release/') - uses: apache/logging-parent/.github/workflows/deploy-release-reusable.yaml@main - secrets: inherit - # Write permissions to allow the Maven `revision` property update, changelog release, etc. + uses: apache/logging-parent/.github/workflows/merge-dependabot-reusable.yaml@main permissions: - contents: write - with: - project-name: log4j-transform - distribution-attachment-count: 4 + contents: write # to push changelog commits + pull-requests: write # to close the PR + secrets: + GPG_SECRET_KEY: ${{ secrets.GPG_SECRET_KEY }} # to sign commits diff --git a/.mvn/jvm.config b/.mvn/jvm.config index 6f7d1c8..45a0340 100644 --- a/.mvn/jvm.config +++ b/.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 diff --git a/log4j-transform-maven-plugin/pom.xml b/log4j-transform-maven-plugin/pom.xml index 89aea7a..f71be3e 100644 --- a/log4j-transform-maven-plugin/pom.xml +++ b/log4j-transform-maven-plugin/pom.xml @@ -32,6 +32,10 @@ <name>Apache Log4j Transform Maven plugin</name> <description>The Apache Log4j Transform Maven plugin</description> + <properties> + <bnd.skip>true</bnd.skip> + </properties> + <dependencies> <dependency> @@ -67,14 +71,6 @@ <build> <plugins> - <plugin> - <groupId>org.apache.felix</groupId> - <artifactId>maven-bundle-plugin</artifactId> - <configuration> - <skip>true</skip> - </configuration> - </plugin> - <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-invoker-plugin</artifactId> diff --git a/log4j-transform-maven-shade-plugin-extensions/pom.xml b/log4j-transform-maven-shade-plugin-extensions/pom.xml index 64fb904..26bf911 100644 --- a/log4j-transform-maven-shade-plugin-extensions/pom.xml +++ b/log4j-transform-maven-shade-plugin-extensions/pom.xml @@ -32,6 +32,10 @@ <name>Apache Log4j Maven Shade Plugin Transformer</name> <description>Transformer implementation to concatenate Log4j2Plugins.dat files</description> + <properties> + <bnd.skip>true</bnd.skip> + </properties> + <dependencies> <dependency> diff --git a/log4j-transform-parent/pom.xml b/log4j-transform-parent/pom.xml index 735e332..c06577d 100644 --- a/log4j-transform-parent/pom.xml +++ b/log4j-transform-parent/pom.xml @@ -42,11 +42,9 @@ <maven.version>3.9.4</maven.version> <plexus-utils.version>4.0.0</plexus-utils.version> <slf4j.version>2.0.9</slf4j.version> - <spotbugs.version>4.7.3</spotbugs.version> <!-- plugin versions --> <jacoco-maven-plugin.version>0.8.10</jacoco-maven-plugin.version> - <maven-bundle-plugin.version>5.1.8</maven-bundle-plugin.version> <maven-invoker-plugin.version>3.5.1</maven-invoker-plugin.version> <maven-shade-plugin.version>3.5.0</maven-shade-plugin.version> <surefire.version>3.0.0-M7</surefire.version> @@ -134,12 +132,6 @@ <version>${slf4j.version}</version> </dependency> - <dependency> - <groupId>com.github.spotbugs</groupId> - <artifactId>spotbugs-annotations</artifactId> - <version>${spotbugs.version}</version> - </dependency> - </dependencies> </dependencyManagement> @@ -153,12 +145,6 @@ <version>${jacoco-maven-plugin.version}</version> </plugin> - <plugin> - <groupId>org.apache.felix</groupId> - <artifactId>maven-bundle-plugin</artifactId> - <version>${maven-bundle-plugin.version}</version> - </plugin> - <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-invoker-plugin</artifactId> diff --git a/log4j-transform-perf/pom.xml b/log4j-transform-perf/pom.xml index ea9017d..8fc6d08 100644 --- a/log4j-transform-perf/pom.xml +++ b/log4j-transform-perf/pom.xml @@ -32,6 +32,7 @@ <description>Performance tests for Apache Log4j Transformation Tools</description> <properties> + <bnd.skip>true</bnd.skip> <maven.install.skip>true</maven.install.skip> <maven.deploy.skip>true</maven.deploy.skip> <spotbugs.skip>true</spotbugs.skip> diff --git a/log4j-weaver/pom.xml b/log4j-weaver/pom.xml index cf5052a..eeb968b 100644 --- a/log4j-weaver/pom.xml +++ b/log4j-weaver/pom.xml @@ -53,6 +53,12 @@ <artifactId>commons-lang3</artifactId> </dependency> + <dependency> + <groupId>org.osgi</groupId> + <artifactId>osgi.annotation</artifactId> + <scope>provided</scope> + </dependency> + <dependency> <groupId>com.github.spotbugs</groupId> <artifactId>spotbugs-annotations</artifactId> @@ -103,13 +109,4 @@ </dependencies> - <build> - <plugins> - <plugin> - <groupId>org.apache.felix</groupId> - <artifactId>maven-bundle-plugin</artifactId> - </plugin> - </plugins> - </build> - </project> diff --git a/log4j-weaver/src/main/java/org/apache/logging/log4j/weaver/log4j2/package-info.java b/log4j-weaver/src/main/java/org/apache/logging/log4j/weaver/log4j2/package-info.java new file mode 100644 index 0000000..c397a80 --- /dev/null +++ b/log4j-weaver/src/main/java/org/apache/logging/log4j/weaver/log4j2/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ +@Export +package org.apache.logging.log4j.weaver.log4j2; + +import org.osgi.annotation.bundle.Export; diff --git a/log4j-weaver/src/main/java/org/apache/logging/log4j/weaver/package-info.java b/log4j-weaver/src/main/java/org/apache/logging/log4j/weaver/package-info.java new file mode 100644 index 0000000..58f9d52 --- /dev/null +++ b/log4j-weaver/src/main/java/org/apache/logging/log4j/weaver/package-info.java @@ -0,0 +1,20 @@ +/* + * 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. + */ +@Export +package org.apache.logging.log4j.weaver; + +import org.osgi.annotation.bundle.Export; diff --git a/pom.xml b/pom.xml index 745af60..7428d32 100644 --- a/pom.xml +++ b/pom.xml @@ -31,7 +31,7 @@ <parent> <groupId>org.apache.logging</groupId> <artifactId>logging-parent</artifactId> - <version>10.0.0</version> + <version>10.1.1</version> </parent> <groupId>org.apache.logging.log4j</groupId> @@ -39,7 +39,7 @@ <version>${revision}</version> <packaging>pom</packaging> - <url>https://github.com/apache/logging-log4j-transform</url> + <url>https://logging.apache.org/log4j/transform</url> <inceptionYear>2022</inceptionYear> @@ -107,6 +107,8 @@ </properties> + <!-- `dependencyManagement` must only contain `log4j-transform` modules and nothing else! + Modules here must have a corresponding entry in `modules` block above! --> <dependencyManagement> <dependencies> diff --git a/src/changelog/.0.x.x/.release-notes.adoc.ftl b/src/changelog/.0.x.x/.release-notes.adoc.ftl new file mode 100644 index 0000000..673ebf9 --- /dev/null +++ b/src/changelog/.0.x.x/.release-notes.adoc.ftl @@ -0,0 +1,43 @@ +//// + 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 `.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-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}] +=== ${release.version} + +<#if release.date?has_content>Release date:: ${release.date}</#if> + +This is the second release of the project. + +<#include "../.changelog.adoc.ftl"> diff --git a/src/changelog/.0.x.x/.release-notes.md.ftl b/src/changelog/.0.x.x/.release-notes.md.ftl deleted file mode 100644 index c1d7377..0000000 --- a/src/changelog/.0.x.x/.release-notes.md.ftl +++ /dev/null @@ -1,22 +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. - --> - -# ${release.version}<#if release.date?has_content> (${release.date})</#if> - -This is the second release of the project. - -<#include "../.changelog.md.ftl"> diff --git a/src/changelog/.0.x.x/logging-parent-update.xml b/src/changelog/.0.x.x/logging-parent-update.xml index 26d6d2e..26fb730 100644 --- a/src/changelog/.0.x.x/logging-parent-update.xml +++ b/src/changelog/.0.x.x/logging-parent-update.xml @@ -3,6 +3,7 @@ xmlns="http://logging.apache.org/log4j/changelog"; xsi:schemaLocation="http://logging.apache.org/log4j/changelog https://logging.apache.org/log4j/changelog-0.1.1.xsd"; type="changed"> + <author id="github:ppkarwasz"/> <author id="github:vy"/> - <description format="markdown">Migrated to `logging-parent` 10.0.0 and adopted its CI infrastructure</description> + <description format="asciidoc">Migrated to `logging-parent` 10.1.1 and adopted its CI and `pom.xml` infrastructure</description> </entry> diff --git a/src/changelog/.changelog.md.ftl b/src/changelog/.changelog.adoc.ftl similarity index 76% rename from src/changelog/.changelog.md.ftl rename to src/changelog/.changelog.adoc.ftl index 6ecfef8..ebd41f0 100644 --- a/src/changelog/.changelog.md.ftl +++ b/src/changelog/.changelog.adoc.ftl @@ -14,13 +14,13 @@ ~ See the License for the specific language governing permissions and ~ limitations under the License. --> -<#if entriesByType?size gt 0>## Changes +<#if entriesByType?size gt 0> <#list entriesByType as entryType, entries> -### ${entryType?capitalize} +==== ${entryType?capitalize} <#list entries as entry> -* ${entry.description.text?replace("\\s+", " ", "r")}<#if entry.issues?has_content> (<#list entry.issues as issue><#if issue.link?starts_with("https://github.com/apache/logging-log4j-transform";)>#${issue.id}<#else>[${issue.id}](${issue.link})</#if><#if issue?has_next>, </#if></#list>)</#if> +* ${entry.description.text?replace("\\s+", " ", "r")}<#if entry.issues?has_content> (<#list entry.issues as issue>${issue.link}[${issue.id}]<#if issue?has_next>, </#if></#list>)</#if> </#list> </#list> </#if> diff --git a/src/changelog/.index.adoc.ftl b/src/changelog/.index.adoc.ftl new file mode 100644 index 0000000..8c4ff21 --- /dev/null +++ b/src/changelog/.index.adoc.ftl @@ -0,0 +1,41 @@ +//// + 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 + +<#list releases as release><#if release.changelogEntryCount gt 0> +include::_release-notes/_${release.version}.adoc[] +</#if></#list> diff --git a/src/changelog/.index.md.ftl b/src/changelog/.index.md.ftl deleted file mode 100644 index 693f1f8..0000000 --- a/src/changelog/.index.md.ftl +++ /dev/null @@ -1,22 +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. - --> - -# Release Notes - -<#list releases as release> -* [${release.version}](${release.version}.md)<#if release.date?has_content> (${release.date})</#if> -</#list> diff --git a/src/changelog/0.1.0/.release-notes.adoc.ftl b/src/changelog/0.1.0/.release-notes.adoc.ftl new file mode 100644 index 0000000..a3c917c --- /dev/null +++ b/src/changelog/0.1.0/.release-notes.adoc.ftl @@ -0,0 +1,43 @@ +//// + 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 `.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-${release.version?replace("[^a-zA-Z0-9]", "-", "r")}] +=== ${release.version} + +<#if release.date?has_content>Release date:: ${release.date}</#if> + +This is the first release of the project. + +<#include "../.changelog.adoc.ftl"> diff --git a/src/changelog/0.1.0/.release-notes.md.ftl b/src/changelog/0.1.0/.release-notes.md.ftl deleted file mode 100644 index 89bb2c3..0000000 --- a/src/changelog/0.1.0/.release-notes.md.ftl +++ /dev/null @@ -1,22 +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. - --> - -# ${release.version}<#if release.date?has_content> (${release.date})</#if> - -This is the first release of the project. - -<#include "../.changelog.md.ftl"> diff --git a/src/changelog/0.1.0/LOG4J2-3638_Provide_Maven_plugin_to_inline_location.xml b/src/changelog/0.1.0/LOG4J2-3638_Provide_Maven_plugin_to_inline_location.xml index 14ada66..6a3986a 100644 --- a/src/changelog/0.1.0/LOG4J2-3638_Provide_Maven_plugin_to_inline_location.xml +++ b/src/changelog/0.1.0/LOG4J2-3638_Provide_Maven_plugin_to_inline_location.xml @@ -21,5 +21,5 @@ type="added"> <issue id="LOG4J2-3638" link="https://issues.apache.org/jira/browse/LOG4J2-3638"/> <author id="github:ppkarwasz"/> - <description format="markdown">Added `log4j-transform-maven-plugin` bytecode transformation tool to provide location information without reflection</description> + <description format="asciidoc">Added `log4j-transform-maven-plugin` bytecode transformation tool to provide location information without reflection</description> </entry> diff --git a/src/changelog/0.1.0/LOG4J2-673_Maven_Shade_resource_transformer.xml b/src/changelog/0.1.0/LOG4J2-673_Maven_Shade_resource_transformer.xml index 5cde8f4..bcdd328 100644 --- a/src/changelog/0.1.0/LOG4J2-673_Maven_Shade_resource_transformer.xml +++ b/src/changelog/0.1.0/LOG4J2-673_Maven_Shade_resource_transformer.xml @@ -22,5 +22,5 @@ <issue id="LOG4J2-673" link="https://issues.apache.org/jira/browse/LOG4J2-673"/> <author id="github:edwgiz" name="Eduard Gizatullin"/> <author id="github:ppkarwasz"/> - <description format="markdown">Added `log4j-transform-maven-shade-plugin-extensions` resource transformer for the Maven Shade Plugin to merge `Log4j2Plugins.dat` plugin caches</description> + <description format="asciidoc">Added `log4j-transform-maven-shade-plugin-extensions` resource transformer for the Maven Shade Plugin to merge `Log4j2Plugins.dat` plugin caches</description> </entry> diff --git a/src/site/_release-notes.adoc b/src/site/_release-notes.adoc new file mode 100644 index 0000000..c6036e5 --- /dev/null +++ b/src/site/_release-notes.adoc @@ -0,0 +1,40 @@ +//// + 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/_0.x.x.adoc[] +include::_release-notes/_0.1.0.adoc[] diff --git a/src/site/_release-notes/_0.1.0.adoc b/src/site/_release-notes/_0.1.0.adoc new file mode 100644 index 0000000..59d55ac --- /dev/null +++ b/src/site/_release-notes/_0.1.0.adoc @@ -0,0 +1,47 @@ +//// + 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 `.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-0-1-0] +=== 0.1.0 + +Release date:: 2023-05-05 + +This is the first release of the project. + + +==== Added + +* Added `log4j-transform-maven-plugin` bytecode transformation tool to provide location information without reflection (https://issues.apache.org/jira/browse/LOG4J2-3638[LOG4J2-3638]) +* Added `log4j-transform-maven-shade-plugin-extensions` resource transformer for the Maven Shade Plugin to merge `Log4j2Plugins.dat` plugin caches (https://issues.apache.org/jira/browse/LOG4J2-673[LOG4J2-673]) diff --git a/src/site/_release-notes/_0.x.x.adoc b/src/site/_release-notes/_0.x.x.adoc new file mode 100644 index 0000000..0b3f3d5 --- /dev/null +++ b/src/site/_release-notes/_0.x.x.adoc @@ -0,0 +1,46 @@ +//// + 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 `.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-0-x-x] +=== 0.x.x + + + +This is the second release of the project. + + +==== Changed + +* Migrated to `logging-parent` 10.1.1 and adopted its CI and `pom.xml` infrastructure
