This is an automated email from the ASF dual-hosted git repository.
echauchot pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 667d3a4cf7f [hotfix][doc] improve comments in archunit.properties
667d3a4cf7f is described below
commit 667d3a4cf7f59eb488dbbc4d4333df5220c85158
Author: Etienne Chauchot <[email protected]>
AuthorDate: Wed Nov 15 15:25:21 2023 +0100
[hotfix][doc] improve comments in archunit.properties
---
.../src/test/resources/archunit.properties | 10 +++++++---
.../src/test/resources/archunit.properties | 10 +++++++---
.../src/test/resources/archunit.properties | 10 +++++++---
3 files changed, 21 insertions(+), 9 deletions(-)
diff --git
a/flink-architecture-tests/flink-architecture-tests-production/src/test/resources/archunit.properties
b/flink-architecture-tests/flink-architecture-tests-production/src/test/resources/archunit.properties
index 15be88c95ba..40d5a8ad5ee 100644
---
a/flink-architecture-tests/flink-architecture-tests-production/src/test/resources/archunit.properties
+++
b/flink-architecture-tests/flink-architecture-tests-production/src/test/resources/archunit.properties
@@ -16,13 +16,17 @@
# limitations under the License.
#
-# By default we allow removing existing violations, but fail when new
violations are added.
+# This controls if the violation store is writable
freeze.store.default.allowStoreUpdate=true
-# Enable this if a new (frozen) rule has been added in order to create the
initial store and record the existing violations.
+# Enable this if a new rule was added or the description of an existing rule
has changed.
+# It is needed to record future violations of this rule.
+# If omitted, future violations of the rule will not be considered as
violations as the initial store was not created for this rule.
#freeze.store.default.allowStoreCreation=true
-# Enable this to add allow new violations to be recorded.
+# Enable this to record the current state of violations.
+# This can make sense, because current violations are consciously accepted and
should be added to the store
+# By default we allow removing existing violations, but fail when new
violations are added
# NOTE: Adding new violations should be avoided when possible. If the rule was
correct to flag a new
# violation, please try to avoid creating the violation. If the
violation was created due to a
# shortcoming of the rule, file a JIRA issue so the rule can be improved.
diff --git
a/flink-architecture-tests/flink-architecture-tests-test/src/test/resources/archunit.properties
b/flink-architecture-tests/flink-architecture-tests-test/src/test/resources/archunit.properties
index 15be88c95ba..40d5a8ad5ee 100644
---
a/flink-architecture-tests/flink-architecture-tests-test/src/test/resources/archunit.properties
+++
b/flink-architecture-tests/flink-architecture-tests-test/src/test/resources/archunit.properties
@@ -16,13 +16,17 @@
# limitations under the License.
#
-# By default we allow removing existing violations, but fail when new
violations are added.
+# This controls if the violation store is writable
freeze.store.default.allowStoreUpdate=true
-# Enable this if a new (frozen) rule has been added in order to create the
initial store and record the existing violations.
+# Enable this if a new rule was added or the description of an existing rule
has changed.
+# It is needed to record future violations of this rule.
+# If omitted, future violations of the rule will not be considered as
violations as the initial store was not created for this rule.
#freeze.store.default.allowStoreCreation=true
-# Enable this to add allow new violations to be recorded.
+# Enable this to record the current state of violations.
+# This can make sense, because current violations are consciously accepted and
should be added to the store
+# By default we allow removing existing violations, but fail when new
violations are added
# NOTE: Adding new violations should be avoided when possible. If the rule was
correct to flag a new
# violation, please try to avoid creating the violation. If the
violation was created due to a
# shortcoming of the rule, file a JIRA issue so the rule can be improved.
diff --git
a/flink-connectors/flink-connector-base/src/test/resources/archunit.properties
b/flink-connectors/flink-connector-base/src/test/resources/archunit.properties
index 15be88c95ba..40d5a8ad5ee 100644
---
a/flink-connectors/flink-connector-base/src/test/resources/archunit.properties
+++
b/flink-connectors/flink-connector-base/src/test/resources/archunit.properties
@@ -16,13 +16,17 @@
# limitations under the License.
#
-# By default we allow removing existing violations, but fail when new
violations are added.
+# This controls if the violation store is writable
freeze.store.default.allowStoreUpdate=true
-# Enable this if a new (frozen) rule has been added in order to create the
initial store and record the existing violations.
+# Enable this if a new rule was added or the description of an existing rule
has changed.
+# It is needed to record future violations of this rule.
+# If omitted, future violations of the rule will not be considered as
violations as the initial store was not created for this rule.
#freeze.store.default.allowStoreCreation=true
-# Enable this to add allow new violations to be recorded.
+# Enable this to record the current state of violations.
+# This can make sense, because current violations are consciously accepted and
should be added to the store
+# By default we allow removing existing violations, but fail when new
violations are added
# NOTE: Adding new violations should be avoided when possible. If the rule was
correct to flag a new
# violation, please try to avoid creating the violation. If the
violation was created due to a
# shortcoming of the rule, file a JIRA issue so the rule can be improved.
