You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2023/01/24 18:45:45 UTC
[logging-log4j-tools] branch master updated (3489746 -> 48a66f9)
This is an automated email from the ASF dual-hosted git repository.
vy pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git
from 3489746 Add XSD for changelog files
new 30724a7 Clean-up GitHub templates
new 1ec4bfb Minor `log4j-changelog` XSD improvements (#13)
new 48a66f9 Removed `security` as a change type from `log4j-changelog` (#14)
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.editorconfig | 2 +-
.github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++---------------
.github/ISSUE_TEMPLATE/feature_request.md | 20 ++++------------
.github/ISSUE_TEMPLATE/question.md | 15 ------------
.github/pull_request_template.md | 8 +++++++
CHANGELOG.adoc | 4 ++++
log4j-changelog/README.adoc | 3 +--
.../logging/log4j/changelog/ChangelogEntry.java | 4 +---
.../src/main/resources/log4j-changelog.xsd | 12 +++++-----
log4j-tools-parent/pom.xml | 3 +++
10 files changed, 37 insertions(+), 62 deletions(-)
create mode 100644 .github/pull_request_template.md
[logging-log4j-tools] 01/03: Clean-up GitHub templates
Posted by vy...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git
commit 30724a7e0979eb789f5f56a62f1a0257940462d2
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Sun Jan 22 21:15:43 2023 +0100
Clean-up GitHub templates
---
.github/ISSUE_TEMPLATE/bug_report.md | 28 +++++++++-------------------
.github/ISSUE_TEMPLATE/feature_request.md | 20 ++++----------------
.github/ISSUE_TEMPLATE/question.md | 15 ---------------
.github/pull_request_template.md | 8 ++++++++
log4j-tools-parent/pom.xml | 3 +++
5 files changed, 24 insertions(+), 50 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 3520d6b..0ca2a07 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,18 +1,3 @@
-# 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.
-
---
name: Bug report
about: Submit a bug report
@@ -20,18 +5,23 @@ about: Submit a bug report
## Description
-A clear and concise description of what the bug is.
+[A clear and concise description of what the bug is.]
## Configuration
-**Version:** ...
+**Version:** [`log4j-tools` version]
-**Operating system:** ...
+**Operating system:** [OS and version]
-**JDK:** ...
+**JDK:** [JDK distribution and version]
## Logs
```
Stacktraces, errors, etc. relevant applications logs.
```
+
+## Reproduction
+
+[An isolated test reproducing the test.
+JUnit tests similar to the ones in the code base are extremely appreciated.]
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 301c59a..57770a1 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,21 +1,9 @@
-# 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.
-
---
name: Feature request
about: Submit a feature request
---
-A clear and concise description of feature requested.
+**Warning!**
+It is highly recommended to discuss feature requests in [the mailing lists](https://logging.apache.org/log4j/2.x/support.html) first.
+
+[A clear and concise description of the feature requested.]
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
index f64cccd..33c2d46 100644
--- a/.github/ISSUE_TEMPLATE/question.md
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -1,18 +1,3 @@
-# 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: Question
about: Ask a question
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..ba288bd
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,8 @@
+[A clear and concise description of what the pull request is for along with a reference to the associated issue IDs, if they exist.]
+
+## Checklist
+
+* `./mvnw verify` succeeds (if it fails due to code formatting issues reported by Spotless, simply run `spotless:apply` and retry)
+* Changes contain an entry in the `CHANGELOG.adoc`
+* Tests for the changes are provided
+* [Commits are signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) (optional, but highly recommended)
diff --git a/log4j-tools-parent/pom.xml b/log4j-tools-parent/pom.xml
index 8f6e229..671e311 100644
--- a/log4j-tools-parent/pom.xml
+++ b/log4j-tools-parent/pom.xml
@@ -181,6 +181,9 @@
<!-- IntelliJ IDEA files: -->
<exclude>.idea/**/*</exclude>
<exclude>**/*.iml</exclude>
+ <!-- License headers in GitHub templates pollute the prompt displayed to the user: -->
+ <exclude>.github/ISSUE_TEMPLATE/*.md</exclude>
+ <exclude>.github/pull_request_template.md</exclude>
</excludes>
</configuration>
<executions>
[logging-log4j-tools] 03/03: Removed `security` as a change type from `log4j-changelog` (#14)
Posted by vy...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git
commit 48a66f9bfdbccf83861849a170838e87d05d1d74
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Tue Jan 24 19:46:55 2023 +0100
Removed `security` as a change type from `log4j-changelog` (#14)
---
CHANGELOG.adoc | 2 ++
log4j-changelog/README.adoc | 3 +--
.../main/java/org/apache/logging/log4j/changelog/ChangelogEntry.java | 4 +---
log4j-changelog/src/main/resources/log4j-changelog.xsd | 1 -
4 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
index 37a456a..ed63ff4 100644
--- a/CHANGELOG.adoc
+++ b/CHANGELOG.adoc
@@ -17,6 +17,8 @@ limitations under the License.
== Unreleased
+* Removed `security` as a change type from `log4j-changelog` (for https://github.com/apache/logging-log4j-tools/issues/14[#14] by Ralph Goers, Volkan Yazıcı)
+
* Added XSD for `log4j-changelog` XML files (for https://github.com/apache/logging-log4j-tools/issues/13[#13] by Piotr P. Karwasz, Volkan Yazıcı)
* Added `log4j-changelog-maven-plugin` module and renamed `log4j.changelog.exporter.outputDirectory` property to `log4j.changelog.outputDirectory` (for https://github.com/apache/logging-log4j-tools/issues/20[#20] by Ralph Goers, Volkan Yazıcı)
diff --git a/log4j-changelog/README.adoc b/log4j-changelog/README.adoc
index 7f8ba83..1e13468 100644
--- a/log4j-changelog/README.adoc
+++ b/log4j-changelog/README.adoc
@@ -174,13 +174,12 @@ A sample _changelog entry_ file is shared below.
Some remarks about the structure of changelog entry files:
* The root element must be named `entry`
-* `entry.type` attribute is required and must be one of the https://keepachangelog.com/en/1.0.0/#how[_Keep a Changelog_ change types]:
+* `entry.type` attribute is required and must be one of the change types:
** `added` – for new features
** `changed` – for changes in existing functionality
** `deprecated` – for soon-to-be removed features
** `removed` – for now removed features
** `fixed` – for any bug fixes
-** `security` – for vulnerabilities
* `issue` element is optional, and, if present, must contain `id` and `link` attributes
* `author` element must have at least one of `id` or `name` attributes
* There must be at least one `author`
diff --git a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogEntry.java b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogEntry.java
index 6d2b239..f31d36a 100644
--- a/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogEntry.java
+++ b/log4j-changelog/src/main/java/org/apache/logging/log4j/changelog/ChangelogEntry.java
@@ -48,9 +48,7 @@ public final class ChangelogEntry {
REMOVED,
- FIXED,
-
- SECURITY;
+ FIXED;
private String toXmlAttribute() {
return toString().toLowerCase(Locale.US);
diff --git a/log4j-changelog/src/main/resources/log4j-changelog.xsd b/log4j-changelog/src/main/resources/log4j-changelog.xsd
index 754aeb4..4f17b15 100644
--- a/log4j-changelog/src/main/resources/log4j-changelog.xsd
+++ b/log4j-changelog/src/main/resources/log4j-changelog.xsd
@@ -59,7 +59,6 @@
<enumeration value="deprecated"/>
<enumeration value="removed"/>
<enumeration value="fixed"/>
- <enumeration value="security"/>
</restriction>
</simpleType>
[logging-log4j-tools] 02/03: Minor `log4j-changelog` XSD improvements (#13)
Posted by vy...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git
commit 1ec4bfb7a8b0566ff868a1d9a492b6f848d30eb0
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Tue Jan 24 19:41:39 2023 +0100
Minor `log4j-changelog` XSD improvements (#13)
---
.editorconfig | 2 +-
CHANGELOG.adoc | 2 ++
log4j-changelog/src/main/resources/log4j-changelog.xsd | 11 ++++++-----
3 files changed, 9 insertions(+), 6 deletions(-)
diff --git a/.editorconfig b/.editorconfig
index 4274445..6c3d154 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -56,7 +56,7 @@ ij_any_while_brace_force = always
ij_java_doc_align_param_comments = false
ij_java_doc_align_exception_comments = false
-[*.{xml,properties,yml,yaml,json}]
+[*.{xml,xsd,properties,yml,yaml,json}]
indent_size = 2
[*.{md,adoc}]
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
index fe2ce95..37a456a 100644
--- a/CHANGELOG.adoc
+++ b/CHANGELOG.adoc
@@ -17,6 +17,8 @@ limitations under the License.
== Unreleased
+* Added XSD for `log4j-changelog` XML files (for https://github.com/apache/logging-log4j-tools/issues/13[#13] by Piotr P. Karwasz, Volkan Yazıcı)
+
* Added `log4j-changelog-maven-plugin` module and renamed `log4j.changelog.exporter.outputDirectory` property to `log4j.changelog.outputDirectory` (for https://github.com/apache/logging-log4j-tools/issues/20[#20] by Ralph Goers, Volkan Yazıcı)
== 0.1.0 (2023-01-10)
diff --git a/log4j-changelog/src/main/resources/log4j-changelog.xsd b/log4j-changelog/src/main/resources/log4j-changelog.xsd
index bf6993e..754aeb4 100644
--- a/log4j-changelog/src/main/resources/log4j-changelog.xsd
+++ b/log4j-changelog/src/main/resources/log4j-changelog.xsd
@@ -16,8 +16,10 @@
limitations under the License.
-->
<schema xmlns="http://www.w3.org/2001/XMLSchema"
- targetNamespace="https://logging.apache.org/log4j/changelog"
- xmlns:cl="https://logging.apache.org/log4j/changelog" elementFormDefault="qualified">
+ targetNamespace="https://logging.apache.org/log4j/changelog"
+ xmlns:cl="https://logging.apache.org/log4j/changelog"
+ elementFormDefault="qualified"
+ version="0.1.0">
<element name="release">
<complexType>
@@ -25,7 +27,6 @@
<extension base="string">
<attribute name="version" use="required"/>
<attribute name="date" type="date" use="required"/>
- <attribute name="schemaVersion" use="required" fixed="1.0"/>
</extension>
</simpleContent>
</complexType>
@@ -39,7 +40,6 @@
<element name="description" type="cl:descriptionType"/>
</sequence>
<attribute name="type" type="cl:changeType" use="required"/>
- <attribute name="schemaVersion" use="required" fixed="1.0"/>
</complexType>
</element>
@@ -67,7 +67,7 @@
<simpleContent>
<extension base="string">
<attribute name="id" type="string"/>
- <attribute name="name"/>
+ <attribute name="name" type="string"/>
</extension>
</simpleContent>
</complexType>
@@ -79,4 +79,5 @@
</extension>
</simpleContent>
</complexType>
+
</schema>