From a7877616852164d14494af6812f7e94d1d938ec1 Mon Sep 17 00:00:00 2001 From: csviri Date: Fri, 30 Sep 2022 14:12:07 +0200 Subject: [PATCH 1/3] docs: introduce ADRs --- adr/001-Introducing-ADRs.md | 29 +++++++++++++++++++ .../operator/MultiVersionCRDIT.java | 1 + 2 files changed, 30 insertions(+) create mode 100644 adr/001-Introducing-ADRs.md diff --git a/adr/001-Introducing-ADRs.md b/adr/001-Introducing-ADRs.md new file mode 100644 index 0000000000..3a432e8094 --- /dev/null +++ b/adr/001-Introducing-ADRs.md @@ -0,0 +1,29 @@ +# Using Architectural Decision Records + +In order to into to document and facilitate discussion over architecture and other design question of the project +we introduce usage of [ADR](https://adr.github.io/). + +In each ADR file, write these sections: + +# Title + +## Status + +What is the status, such as proposed, accepted, rejected, deprecated, superseded, etc.? + +## Context + +What is the issue that we're seeing that is motivating this decision or change? + +## Decision + +What is the change that we're proposing and/or doing? + +## Consequences + +What becomes easier or more difficult to do because of this change? + +## Notes + +Other notes optionally added to the ADR. +Soo other good materials for the ADRs: \ No newline at end of file diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java index 65bf839ff4..eecb930560 100644 --- a/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java +++ b/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java @@ -3,6 +3,7 @@ import java.time.Duration; import java.util.HashMap; +import io.fabric8.kubernetes.client.utils.Serialization; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; From 700c88a976044cd17911b297ce7184473107fc97 Mon Sep 17 00:00:00 2001 From: csviri Date: Fri, 30 Sep 2022 14:14:41 +0200 Subject: [PATCH 2/3] remove unrelated change --- .../test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java | 1 - 1 file changed, 1 deletion(-) diff --git a/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java b/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java index eecb930560..65bf839ff4 100644 --- a/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java +++ b/operator-framework/src/test/java/io/javaoperatorsdk/operator/MultiVersionCRDIT.java @@ -3,7 +3,6 @@ import java.time.Duration; import java.util.HashMap; -import io.fabric8.kubernetes.client.utils.Serialization; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; From c332e01e6c3892b9aabb164e20c948cddc2d7cf9 Mon Sep 17 00:00:00 2001 From: csviri Date: Fri, 30 Sep 2022 14:16:18 +0200 Subject: [PATCH 3/3] ignore adr only changes for build --- .github/workflows/e2e-test.yml | 2 ++ .github/workflows/pr.yml | 1 + .github/workflows/sonar.yml | 2 ++ 3 files changed, 5 insertions(+) diff --git a/.github/workflows/e2e-test.yml b/.github/workflows/e2e-test.yml index 1007878ea9..09bd6a1a12 100644 --- a/.github/workflows/e2e-test.yml +++ b/.github/workflows/e2e-test.yml @@ -5,10 +5,12 @@ on: pull_request: paths-ignore: - 'docs/**' + - 'adr/**' branches: [ main, next ] push: paths-ignore: - 'docs/**' + - 'adr/**' branches: - main - next diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index d1d405cd91..b36daa3162 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -10,6 +10,7 @@ on: pull_request: paths-ignore: - 'docs/**' + - 'adr/**' branches: [ main, v1, v2, v3, next ] workflow_dispatch: jobs: diff --git a/.github/workflows/sonar.yml b/.github/workflows/sonar.yml index 56c29d00d4..e89f3c3de9 100644 --- a/.github/workflows/sonar.yml +++ b/.github/workflows/sonar.yml @@ -10,10 +10,12 @@ on: push: paths-ignore: - 'docs/**' + - 'adr/**' branches: [ main ] pull_request: paths-ignore: - 'docs/**' + - 'adr/**' types: [ opened, synchronize, reopened ] jobs: