Skip to content

docs: document the release process#728

Draft
chaen wants to merge 2 commits intoDIRACGrid:mainfrom
chaen:doc_makereleases
Draft

docs: document the release process#728
chaen wants to merge 2 commits intoDIRACGrid:mainfrom
chaen:doc_makereleases

Conversation

@chaen
Copy link
Contributor

@chaen chaen commented Jan 19, 2026

No description provided.


## diracx release

[PROCESS TO BE COMPLETED BY ALEXANDRE]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's for you to complete @aldbr

@chaen chaen force-pushed the doc_makereleases branch 2 times, most recently from ee1197a to 4f0fa1d Compare January 19, 2026 15:40
@read-the-docs-community
Copy link

read-the-docs-community bot commented Jan 19, 2026

Documentation build overview

📚 diracx | 🛠️ Build #31720679 | 📁 Comparing f9c40e8 against latest (70bf3c7)


🔍 Preview build

Show files changed (119 files in total): 📝 117 modified | ➕ 2 added | ➖ 0 deleted
File Status
404.html 📝 modified
index.html 📝 modified
REFERENCE/index.html 📝 modified
RUN_PROD/index.html 📝 modified
SECURITY/index.html 📝 modified
SSO/index.html 📝 modified
admin/index.html 📝 modified
dev/index.html 📝 modified
roadmap/index.html 📝 modified
user/index.html 📝 modified
admin/explanations/index.html 📝 modified
admin/how-to/index.html 📝 modified
admin/reference/index.html 📝 modified
admin/tutorials/index.html 📝 modified
dev/explanations/index.html 📝 modified
dev/how-to/index.html 📝 modified
dev/reference/index.html 📝 modified
dev/tutorials/index.html 📝 modified
user/explanations/index.html 📝 modified
user/how-to/index.html 📝 modified
user/reference/index.html 📝 modified
user/tutorials/index.html 📝 modified
admin/explanations/auth-with-diracx/index.html 📝 modified
admin/explanations/auth-with-external/index.html 📝 modified
admin/explanations/chart-structure/index.html 📝 modified
admin/explanations/configuration/index.html 📝 modified
admin/explanations/database-management/index.html 📝 modified
admin/explanations/manage-web-release/index.html 📝 modified
admin/explanations/opentelemetry/index.html 📝 modified
admin/explanations/sandbox-store/index.html 📝 modified
admin/explanations/user-management/index.html 📝 modified
admin/how-to/debugging/index.html 📝 modified
admin/how-to/install/index.html 📝 modified
admin/how-to/rotate-a-secret/index.html 📝 modified
admin/how-to/upgrading/index.html 📝 modified
admin/reference/env-variables/index.html 📝 modified
admin/reference/security_model/index.html 📝 modified
admin/reference/settings-and-preferences/index.html 📝 modified
admin/reference/values/index.html 📝 modified
admin/tutorials/authentication/index.html 📝 modified
admin/tutorials/run_locally/index.html 📝 modified
dev/explanations/components/index.html 📝 modified
dev/explanations/dependency-management/index.html 📝 modified
dev/explanations/designing-functionality/index.html 📝 modified
dev/explanations/documentation-system/index.html 📝 modified
dev/explanations/extensions/index.html 📝 modified
dev/explanations/repo-structure/index.html 📝 modified
dev/explanations/run_demo/index.html 📝 modified
dev/explanations/testing/index.html 📝 modified
dev/explanations/web-architecture/index.html 📝 modified
dev/explanations/web-testing/index.html 📝 modified
dev/how-to/add-a-cli-command/index.html 📝 modified
dev/how-to/add-a-db/index.html 📝 modified
dev/how-to/add-a-route/index.html 📝 modified
dev/how-to/add-a-setting/index.html 📝 modified
dev/how-to/add-a-task/index.html 📝 modified
dev/how-to/add-a-test/index.html 📝 modified
dev/how-to/add-functionality/index.html 📝 modified
dev/how-to/client-customization/index.html 📝 modified
dev/how-to/client-extension/index.html 📝 modified
dev/how-to/client-generation/index.html 📝 modified
dev/how-to/contribute/index.html 📝 modified
dev/how-to/contribute-to-web/index.html 📝 modified
dev/how-to/create-web-application/index.html 📝 modified
dev/how-to/develop-legacy-dirac/index.html 📝 modified
dev/how-to/extend-diracx/index.html 📝 modified
dev/how-to/make-a-release/index.html ➕ added
dev/how-to/manage-web-extension/index.html 📝 modified
dev/how-to/setup-web-environment/index.html 📝 modified
dev/how-to/use-the-demo/index.html 📝 modified
dev/how-to/write-docs/index.html 📝 modified
dev/reference/application-state/index.html 📝 modified
dev/reference/client-metapathfinder/index.html 📝 modified
dev/reference/coding-conventions/index.html 📝 modified
dev/reference/configuration/index.html 📝 modified
dev/reference/db-transaction-model/index.html 📝 modified
dev/reference/dependency-injection/index.html 📝 modified
dev/reference/entrypoints/index.html 📝 modified
dev/reference/env-variables/index.html 📝 modified
dev/reference/making-releases/index.html ➕ added
dev/reference/pixi-tasks/index.html 📝 modified
dev/reference/security-policies/index.html 📝 modified
dev/reference/security-properties/index.html 📝 modified
dev/reference/test-recipes/index.html 📝 modified
dev/reference/web-coding-conventions/index.html 📝 modified
dev/reference/writing-tests/index.html 📝 modified
dev/tutorials/advanced-tutorial/index.html 📝 modified
dev/tutorials/getting-started/index.html 📝 modified
dev/tutorials/larger-developments/index.html 📝 modified
dev/tutorials/making-changes/index.html 📝 modified
dev/tutorials/play-with-auth/index.html 📝 modified
dev/tutorials/run-locally/index.html 📝 modified
dev/tutorials/web-extensions/index.html 📝 modified
dev/tutorials/web-getting-started/index.html 📝 modified
user/how-to/list-and-share-applications/index.html 📝 modified
user/how-to/login-out/index.html 📝 modified
user/how-to/monitor-jobs/index.html 📝 modified
user/reference/client-configuration/index.html 📝 modified
user/reference/known-installations/index.html 📝 modified
user/reference/programmatic-usage/index.html 📝 modified
user/tutorials/getting-started/index.html 📝 modified
admin/how-to/install/connect/index.html 📝 modified
admin/how-to/install/convert-cs/index.html 📝 modified
admin/how-to/install/embracing/index.html 📝 modified
admin/how-to/install/install-kubernetes/index.html 📝 modified
admin/how-to/install/installing/index.html 📝 modified
admin/how-to/install/minimal-requirements/index.html 📝 modified
admin/how-to/install/register-a-vo/index.html 📝 modified
admin/how-to/install/register-the-admin-vo/index.html 📝 modified
dev/explanations/components/api/index.html 📝 modified
dev/explanations/components/cli/index.html 📝 modified
dev/explanations/components/client/index.html 📝 modified
dev/explanations/components/db/index.html 📝 modified
dev/explanations/components/routes/index.html 📝 modified
dev/how-to/use-the-demo/swagger/index.html 📝 modified
dev/how-to/use-the-demo/web/index.html 📝 modified
user/reference/programmatic-usage/command-line-interface/index.html 📝 modified
user/reference/programmatic-usage/https-interface/index.html 📝 modified
user/reference/programmatic-usage/python-interface/index.html 📝 modified

@chaen chaen force-pushed the doc_makereleases branch from 75c0a2a to 3797866 Compare March 2, 2026 13:25
@chaen chaen marked this pull request as ready for review March 5, 2026 09:50
@chaen chaen force-pushed the doc_makereleases branch from 6f79e75 to 18f238c Compare March 9, 2026 09:27
chaen and others added 2 commits March 9, 2026 10:30
Expand paths-ignore in main, integration, and deployment workflows
to cover all Markdown files, the docs directory, and mkdocs.yml.
This avoids running expensive integration tests when only
documentation is modified.
@chaen chaen force-pushed the doc_makereleases branch from 18f238c to f9c40e8 Compare March 9, 2026 09:30
Comment on lines +288 to +290
=== "Gitlab"

This assumes you are
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that expected?

Suggested change
=== "Gitlab"
This assumes you are

diracx -->|renovate| extension
diracx-web -->|renovate| extension-web
extension -->|commit and bump diracx-charts| extension-charts
extension-web -->|commit| extension-charts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we also bump extension-charts if we update extension-web?

Suggested change
extension-web -->|commit| extension-charts
extension-web -->|commit and bump diracx-charts| extension-charts

Comment on lines +272 to +273
diracx -->|commit| diracx-charts
diracx-web -->|commit| diracx-charts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here?

Suggested change
diracx -->|commit| diracx-charts
diracx-web -->|commit| diracx-charts
diracx -->|commit and bump diracx-charts| diracx-charts
diracx-web -->|commit and bump diracx-charts| diracx-charts

git push upstream HEAD:main
```

- TODO: update the release notes manually
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that for another PR? Shall I create an issue for that?

Comment on lines +9 to +24
```mermaid
flowchart LR
subgraph diracx-block["diracx"]
diracx-charts("diracx-charts")
diracx("diracx")
diracx-web("diracx-web")
end


diracx -->|commit| diracx-charts
diracx-web -->|commit| diracx-charts

linkStyle 0 stroke: blue
linkStyle 1 stroke: blue

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't you want to also include DIRAC and DIRACCommon in this diagram?
Else, it looks like it could be moved to Dependencies between diracx, diracx-web and diracx-charts.


- the chart version
- the container versions
- NOT the AppVersion
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure to understand why there is a difference between diracx and diracx-web here.
Can you may be add a comment on that please?


## diracx release

Releases are managed by `ReleasePlease`. The token used to perform it belongs to `diracbot` github user
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we document diracx-web release here? I think yes.
It would be very similar to diracx release.
The only differences are:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it "DIRACGridBot" instead of "diracbot"?

```bash
git commit --allow-empty -m "chore: release 0.0.3" -m "Release-As: v0.0.3"
git push upstream HEAD:main
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also written in make-a-release.md. Shouldn't we add a reference to it here?

@DIRACGridBot DIRACGridBot marked this pull request as draft March 9, 2026 10:26
@aldbr aldbr linked an issue Mar 18, 2026 that may be closed by this pull request

DiracX should be upgraded before upgrading legacy DIRAC installations.

The versioning of `DIRAC`, `DIRACCommon`, `diracx`, `diracx-charts` and all the extensions are very linked to one another.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The versioning of `DIRAC`, `DIRACCommon`, `diracx`, `diracx-charts` and all the extensions are very linked to one another.
The versioning of `DIRAC`, `DIRACCommon`, `diracx`, `diracx-charts` and all the extensions are linked to one another.

- the AppVersion
- the container versions

The `update-charts` CI job in `diracx` pushes a new commit in `diracx-charts`, which results in a new `diracx-charts` release.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a link


## diracx release

Releases are managed by `ReleasePlease`. The token used to perform it belongs to `diracbot` github user
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it "DIRACGridBot" instead of "diracbot"?

@@ -0,0 +1,46 @@
This page describes how to mechanically make releases of DiracX and extensions. See the [reference](../reference/making-releases.md) documentation for more details about how releases are made.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a note to follow this in the presented order.


- TODO: update the release notes manually

4. Merge the PR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Merge the PR
4. Merge the `release-please` PR


# How to make a new DiracX release

1. Merge any PR you want in your release
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this step, it's done asynchronously.

3. Create tag (and optionally [release](<>)) for your extension
4. Updates to extension's "charts" repo will be pushed automatically or via merge requests depending on your setup.

=== "LHCb"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put this in a wiki/note/whatever

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document gubbins-charts

4 participants