Skip to content

Commit 64d5aa6

Browse files
committed
docs(ofrep): point at Appendix F for the CI-exclusion reasoning
Appendix F now carries "Running the suite in CI", promoted there because the same reasoning restated in four adoption READMEs is where it drifted. So this section keeps the mechanism and the local record -- that this module had no testExclusions at all until it was added, which is the appendix's "exclusion nobody wrote down" -- and links to the appendix for the argument rather than paraphrasing it. Also states that no profile in this module touches the property, resolved rather than read: mvn -Pe2e -pl providers/ofrep help:evaluate -Dexpression=testExclusions -> **/e2e/*.java mvn -pl providers/ofrep help:evaluate -Dexpression=testExclusions -> **/e2e/*.java Unlike providers/flagd, which needs an e2e profile for its legacy suites and therefore narrows the pattern instead of clearing it. Signed-off-by: Simon Schrottner <simon.schrottner@flagsmith.com>
1 parent d23afb6 commit 64d5aa6

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

providers/ofrep/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,20 @@ speaks it. The suite reuses the unmodified `flagd-testbed` image and its launchp
8989
repository's convention for a Docker-dependent suite, fed to Surefire by the parent POM; the parent
9090
defines no default, so each module that wants the gate declares it. This module did not, which meant
9191
`mvn verify` started a Compose stack and the suite ran — and failed — in every job that touched
92-
`providers/ofrep`. The exclusion is the fix, and this paragraph is the other half of it: an
93-
exclusion nobody writes down is indistinguishable from an oversight.
92+
`providers/ofrep`. That is the second of the two mistakes
93+
[Appendix F: Running the suite in CI](https://github.com/open-feature/spec/blob/main/specification/appendix-f-provider-conformance.md#running-the-suite-in-ci)
94+
names, and the appendix has the reasoning for the whole policy; the exclusion is the fix and this
95+
paragraph is the other half of it.
96+
97+
This module has no profile that touches the property, so both spellings resolve the same way —
98+
checked rather than read, because that is the appendix's other warning:
99+
100+
```bash
101+
mvn -Pe2e -pl providers/ofrep help:evaluate -Dexpression=testExclusions -DforceStdout
102+
```
103+
104+
The exclusion is Surefire's and not the compiler's, so the suite still builds against the harness in
105+
every job.
94106

95107
The consequence is that **no CI job runs the suite**, so a maintainer runs it by hand before merging
96108
a change to the provider's resolution or error behaviour, and quotes the result in the pull request.

0 commit comments

Comments
 (0)