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 26336a2fe845a5a13f7b78505f822c1182e20ad5 Author: Volkan Yazıcı <[email protected]> AuthorDate: Mon Oct 2 15:25:41 2023 +0200 Point `README.adoc` to the website --- README.adoc | 75 +++++---------------- RELEASE-NOTES.md | 22 ------- RELEASING.adoc | 156 -------------------------------------------- SECURITY.adoc | 21 ------ spotless-license-header.txt | 16 ----- 5 files changed, 18 insertions(+), 272 deletions(-) diff --git a/README.adoc b/README.adoc index b7164b4..cadec6a 100644 --- a/README.adoc +++ b/README.adoc @@ -1,62 +1,23 @@ -// -// 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. -// +//// +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. +//// + https://github.com/apache/logging-log4j-transform/actions[image:https://github.com/apache/logging-log4j-transform/workflows/build/badge.svg[Actions Status]] https://search.maven.org/search?q=g:org.apache.logging.log4j%20a:log4j-transform-bom[image:https://img.shields.io/maven-central/v/org.apache.logging.log4j/log4j-transform-bom.svg[Maven Central]] https://www.apache.org/licenses/LICENSE-2.0.txt[image:https://img.shields.io/github/license/apache/logging-log4j-transform.svg[License]] Tools for binary postprocessing of projects that use https://logging.apache.org/log4j/2.x/[the Apache Log4j2 API]. - -xref:log4j-transform-maven-plugin/README.adoc[`log4j-transform-maven-plugin`]:: -a bytecode weaver that improves logging performance by precomputing the location of your logging statements - -xref:log4j-transform-maven-shade-plugin-extensions/README.adoc[`log4j-transform-maven-shade-plugin-extensions`]:: -a https://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html[resource transformer] for the Apache Maven Shade Plugin that allows you to use additional Log4j 2.x Core component modules - -== Build - -This project generates Java 8 bytecode, though requires Java 17 for compilation. -You can build and test sources using `./mvnw verify` command. - -== Distribution - -In accordance with the Apache Software Foundation's release https://infra.apache.org/release-distribution.html[distribution policy] and https://infra.apache.org/release-publishing.html[creation process], project artifacts are _officially_ accessible from the following locations: - -* ASF https://repository.apache.org/content/repositories/releases[Release] and https://repository.apache.org/content/repositories/snapshots[snapshot] repositories (mirrored to https://central.sonatype.dev/[the Maven Central Repository]) -* ASF https://downloads.apache.org/logging/log4j-transform[Distribution directory] - -See xref:RELEASING.adoc[release instructions] for further details. - -== Support - -Please keep in mind that this project is intended for internal usage only. -You can use GitHub Issues for feature requests and bug reports – not questions! -See https://logging.apache.org/log4j/2.x/support.html[the Log4j support policy] for details. - -== Security - -If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to mailto:[email protected][the Log4j security mailing list]. -See https://logging.apache.org/log4j/2.x/security.html[the Log4j Security page] for further details. - -== License - -Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. -See xref:NOTICE.txt[] distributed with this work for additional information regarding copyright ownership. -The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. -You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0[]. - -Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and limitations under the License. +See https://logging.apache.org/log4j/transform[the project website] for further information. diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md deleted file mode 100644 index a37d693..0000000 --- a/RELEASE-NOTES.md +++ /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. - --> - -This project uses itself, i.e., `log4j-changelog-maven-plugin`, for keeping a changelog and generating release notes. - -Changelog files are located under [`src/changelog`](src/changelog). -Release notes can be generated using `./mvnw -N -P changelog-export` command. -See [`log4j-changelog-maven-plugin`](log4j-changelog-maven-plugin) for details on how it all works. diff --git a/RELEASING.adoc b/RELEASING.adoc deleted file mode 100644 index 8621915..0000000 --- a/RELEASING.adoc +++ /dev/null @@ -1,156 +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. -//// - -// ██ ██ █████ ██████ ███ ██ ██ ███ ██ ██████ ██ -// ██ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██ ██ ██ -// ██ █ ██ ███████ ██████ ██ ██ ██ ██ ██ ██ ██ ██ ███ ██ -// ██ ███ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ -// ███ ███ ██ ██ ██ ██ ██ ████ ██ ██ ████ ██████ ██ -// -// Below instructions are shared by all Maven-based Apache Logging Services projects. -// Be extremely cautious while making changes! - -// Configuration /////////////////////////////////////////////////////////////// - -// Name of the GitHub repository; `logging-parent`, `logging-log4j2`, `logging-log4j-tools`, etc. -:repository-name: logging-log4j-transform - -// Name of the project; `logging-parent`, `log4j`, `log4j-tools` -:project-name: log4j-transform - -// Instructions //////////////////////////////////////////////////////////////// - -= Release instructions - -[WARNING] -==== -In the code examples below, assuming the version to be released is `7.8.0`. -==== - -== Stage the release - -. Create and push the release branch: -+ -[source,bash] ----- -git fetch -p -git checkout -B release/7.8.0 origin/main -git push origin release/7.8.0 ----- -. Verify that the associated https://github.com/apache/{repository-name}/actions[GitHub Actions workflow] succeeds: -.. `revision` property in `pom.xml` is updated -.. Changelog is released (i.e., `src/changelog/7.8.0` folder is populated) -.. *Signed artifacts* are uploaded to the _Staging Repositories_ in https://repository.apache.org/[repository.apache.org] -.. *Signed distribution and its checksum* (e.g., `apache-{project-name}-7.8.0-{bin,src}.{zip,.zip.asc,.zip.sha512}`) are uploaded to https://dist.apache.org/repos/dist/dev/logging/log4j[dist.apache.org/repos/dist/**dev**/logging/log4j] Subversion repository (along with auxiliary files; email texts, etc.) - -+ -If not, commit necessary fixes, push, and repeat. - -+ -[TIP] -==== -GitHub Actions workflow is idempotent. -You can iterate on the `release/7.8.0` branch to perfect it. -==== -. _Close_ the repository in https://repository.apache.org/[repository.apache.org] - -== Vote the release - -. Send the vote email uploaded to the https://dist.apache.org/repos/dist/dev/logging/log4j[dist.apache.org/repos/dist/**dev**/logging/log4j] Subversion repository -+ -[WARNING] -==== -**Fix the cited https://repository.apache.org[repository.apache.org] URL** in the generated email! -It changes after every Nexus deployment. -==== -+ -[WARNING] -==== -Make sure your email is sent in plain text, that is, https://infra.apache.org/contrib-email-tips#nohtml[no HTML]! -If you are using GMail, simply enable the _"Plain text mode"_ while composing your message. -==== - -. Once the consensus is reached within the set time frame, respond to the first post in the thread as follows: -+ -[source] ----- -Adding my +1. - -With that, the release passes with 3 binding +1 votes from <PMC-member-1>, ..., <PMC-member-N>, and me. -I will continue the release process. ----- - -== Publish the release - -=== In the git repository - -. Pull the most recent changes and tags -+ -[source,bash] ----- -git fetch -p ----- -. Tag the release (e.g., `rel/7.8.0`) and push it -+ -[source,bash] ----- -git tag -a rel/7.8.0 <COMMIT-ID> -m 7.8.0 # <1> -git push origin rel/7.8.0 ----- -+ -<1> You can find the `COMMIT-ID` in the generated vote email. -+ -[IMPORTANT] -==== -The ASF infrastructure treats ``rel/``-prefixed git tags special and ensures they are immutable for provenance reasons. -==== -. Merge `release/7.8.0` to `main` -+ -[source,bash] ----- -git checkout main -git merge release/7.8.0 ----- -. Set the revision property to the next development version (e.g., `7.9.0-SNAPSHOT`) in xref:pom.xml[`pom.xml`] -. Commit changes and push the `main` branch -. Delete the local and remote copies of the `release/7.8.0` branch - -=== In the ASF infrastructure - -. _Release_ the repository in https://reporter.apache.org/addrelease.html?logging[repository.apache.org] -. In https://dist.apache.org/repos/dist/release/logging/{project-name}[dist.apache.org/repos/dist] Subversion repository, -.. create the `*release*/logging/{project-name}/7.8.0` folder, and copy the signed sources and their checksum from `*dev*/logging/{project-name}` to there -.. delete the folder from an earlier release in `*release*/logging/{project-name}` (stash the generated announcement email somewhere, you will need it later on) -.. commit changes -. Report the release at https://reporter.apache.org/addrelease.html?logging[reporter.apache.org] - -=== In GitHub - -Once the artifacts are visible in https://central.sonatype.dev/[central.sonatype.dev], https://github.com/apache/{repository-name}/releases/new[create a new release in GitHub] - -. Use the `rel/7.8.0` tag -. Copy release notes from the generated emails - -== Announce the release - -. Send the announcement email uploaded to the https://dist.apache.org/repos/dist/dev/logging/{project-name}[dist.apache.org/repos/dist/**dev**/logging/{project-name}] Subversion repository -+ -[WARNING] -==== -Make sure your email is sent in plain text, that is, https://infra.apache.org/contrib-email-tips#nohtml[no HTML]! -If you are using GMail, simply enable the _"Plain text mode"_ while composing your message. -==== diff --git a/SECURITY.adoc b/SECURITY.adoc deleted file mode 100644 index cbbb429..0000000 --- a/SECURITY.adoc +++ /dev/null @@ -1,21 +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. -//// - -= Security Policy - -If you have encountered an unlisted security vulnerability or other unexpected behaviour that has security impact, please report them privately to mailto:[email protected][the Log4j security mailing list]. -See https://logging.apache.org/log4j/2.x/security.html[the Log4j Security page] for further details. diff --git a/spotless-license-header.txt b/spotless-license-header.txt deleted file mode 100644 index 4f33236..0000000 --- a/spotless-license-header.txt +++ /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. - */
