docs: document how to test diracx-charts changes

.github/workflows/main.yml

@@ -20,6 +20,10 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  DIRACX_CHARTS_REPOSITORY: https://github.com/DIRACGrid/diracx-charts.git
+  DIRACX_CHARTS_BRANCH: master
+
 jobs:
   shellcheck:
     runs-on: ubuntu-latest
@@ -168,7 +172,7 @@ jobs:
           docker image ls -a
       - name: Start demo
         run: |
-          git clone https://github.com/DIRACGrid/diracx-charts.git ../diracx-charts
+          git clone --branch "$DIRACX_CHARTS_BRANCH" --single-branch "$DIRACX_CHARTS_REPOSITORY" ../diracx-charts
 
           declare -a demo_args=()
           demo_args+=("--enable-open-telemetry")

diracx-core/src/diracx/core/settings.py

@@ -175,9 +175,9 @@ def check_retention_greater_than_expiration(self) -> Self:
     )
 
     dirac_client_id: str = "myDIRACClientID"
-    """OAuth2 client identifier for DIRAC services.
+    """OAuth2 client identifier for DIRAC clients (cli, web) to DIRAC services.
 
-    This should match the client ID registered with the identity provider.
+    There is no real reason to change that.
     """
 
     allowed_redirects: list[str] = []

docs/admin/reference/env-variables.md

@@ -25,9 +25,9 @@ Settings for the authentication service.
 
 *Optional*, default value: `myDIRACClientID`
 
-OAuth2 client identifier for DIRAC services.
+OAuth2 client identifier for DIRAC clients (cli, web) to DIRAC services.
 
-This should match the client ID registered with the identity provider.
+There is no real reason to change that.
 
 ### `DIRACX_SERVICE_AUTH_ALLOWED_REDIRECTS`
 

docs/dev/how-to/test-changes-in-diracx-charts.md

@@ -0,0 +1,26 @@
+# Testing against changes in diracx-charts
+
+Changes in `diracx` may require corresponding changes in `diracx-charts` (typically adding a new database for example).
+
+## Testing locally
+
+[run_demo.sh](../explanations/run_demo.md) allows to specify your local version of `diracx`, or `diracx-web`.
+
+```bash
+$ cd diracx-charts/
+$ ./run_demo.sh ../diracx
+```
+
+See the [tutorial](../tutorials/run-locally.md) for detailed example.
+
+## Running the CI
+
+Since the changes are interdependent, it is expected the `diracx` CI to fail. The good practice here is to add a separate commit to your `diracx` PR to point the CI to your own `diracx-charts` branch instead of the master.
+
+This is done in `.github/workflows/main.yml`:
+
+```yaml
+env:
+  DIRACX_CHARTS_REPOSITORY: https://github.com/DIRACGrid/diracx-charts.git
+  DIRACX_CHARTS_BRANCH: master
+```

mkdocs.yml

@@ -174,6 +174,7 @@ nav:
           - New DB: dev/how-to/add-a-db.md
           - New settings: dev/how-to/add-a-setting.md
           - Add a test: dev/how-to/add-a-test.md
+          - Test against changes in diracx-charts: dev/how-to/test-changes-in-diracx-charts.md
         - Extend DiracX:
           - dev/how-to/extend-diracx/index.md
         - Develop legacy DIRAC: dev/how-to/develop-legacy-dirac.md