Skip to content

Commit a38a0c5

Browse files
sawenzelclaude
andcommitted
Document how to test against an unreleased O2
This adds the sentinel file and the instructions for the two escape hatches around the CVMFS-based simulation tests. - A pull request can pin a published release with a sim-tests-tag line. - Touching test/needs-o2-dev enables the source-building o2dev check. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent faad204 commit a38a0c5

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

‎test/README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,3 +112,16 @@ usage: run_tests.sh [--fail-immediately] [--keep-artifacts]
112112
If also not set, this will be set to HEAD. However, if there are unstaged
113113
changes, it will left blank.
114114
```
115+
116+
## When your change needs an unreleased O2
117+
118+
The `Simulation tests against CVMFS` check runs against a published
119+
`O2PDPSuite` release, so a change that depends on an unmerged or unreleased O2
120+
commit cannot pass it. Two escape hatches, in order of preference:
121+
122+
1. If the O2 change is already in a published daily, pin it: add a line
123+
`sim-tests-tag: daily-YYYYMMDD-HHMM-1` to the pull request description.
124+
2. If it is not published anywhere yet, touch `test/needs-o2-dev` with a
125+
one-line reason and a link to the O2 pull request. That enables
126+
`build/O2DPG/sim/o2dev`, which builds O2 from source against `dev`. It is
127+
much slower, so it is opt-in.

‎test/needs-o2-dev‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Touch this file in a pull request that cannot be tested against a published
2+
O2PDPSuite release because it depends on an unreleased change in O2.
3+
Replace this text with a one-line reason and a link to the O2 pull request.
4+
Touching it enables the build/O2DPG/sim/o2dev check, which builds O2 from
5+
source against AliceO2Group/AliceO2 dev.

0 commit comments

Comments
 (0)