docs: document the release process by chaen · Pull Request #728 · DIRACGrid/diracx

chaen · 2026-01-19T13:53:54Z

No description provided.

docs/dev/reference/making-releases.md

read-the-docs-community · 2026-01-19T15:42:09Z

Documentation build overview

📚 diracx | 🛠️ Build #31963873 | 📁 Comparing 7ed64ab against latest (e552651)

🔍 Preview build

Show files changed (123 files in total): 📝 119 modified | ➕ 2 added | ➖ 2 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
assets/home.html	📝 modified
dev/index.html	📝 modified
developers/index.html	➖ deleted
overrides/main.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/job_commands/index.html	➖ deleted
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

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.

docs/dev/explanations/extensions.md

aldbr · 2026-03-09T10:13:29Z

docs/dev/how-to/make-a-release.md

+    git push upstream HEAD:main
+    ```
+
+    - TODO: update the release notes manually


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

docs/dev/reference/making-releases.md

aldbr · 2026-03-09T10:24:04Z

docs/dev/reference/making-releases.md

+
+## diracx release
+
+Releases are managed by `ReleasePlease`. The token used to perform it belongs to `diracbot` github user


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

we are not using diracbot because we don't need it (at least for now)

pypi release becomes npm release for diracx-web-components. See https://www.npmjs.com/package/@dirac-grid/diracx-web-components

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

Can you please push directly to this branch @aldbr ?

I prepared DIRACGrid/diracx-web#484 to align the DiracX-Web release process with the DiracX one. Ideally it needs #527 and another PR that will follow.

Once reviewed and merged, I'll add the diracx-web release process here.

docs/dev/reference/making-releases.md

fstagni · 2026-03-19T08:46:38Z

docs/dev/reference/making-releases.md

+
+## diracx release
+
+Releases are managed by `ReleasePlease`. The token used to perform it belongs to `diracbot` github user


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

docs/dev/how-to/make-a-release.md

fstagni · 2026-03-19T08:51:12Z

docs/dev/how-to/make-a-release.md

+
+    - TODO: update the release notes manually
+
+4. Merge the PR


Suggested change

4. Merge the PR

4. Merge the `release-please` PR

fstagni · 2026-03-19T08:51:34Z

docs/dev/how-to/make-a-release.md

+
+# How to make a new DiracX release
+
+1. Merge any PR you want in your release


Remove this step, it's done asynchronously.

docs/dev/how-to/make-a-release.md

chaen commented Jan 19, 2026

View reviewed changes

docs/dev/reference/making-releases.md Outdated Show resolved Hide resolved

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

chaen force-pushed the doc_makereleases branch from 4f0fa1d to 75c0a2a Compare January 23, 2026 11:07

chaen force-pushed the doc_makereleases branch from 75c0a2a to 3797866 Compare March 2, 2026 13:25

chaen marked this pull request as ready for review March 5, 2026 09:50

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

docs: document the release process

2514036

ci: skip CI workflows for documentation-only changes

f9c40e8

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 force-pushed the doc_makereleases branch from 18f238c to f9c40e8 Compare March 9, 2026 09:30

aldbr requested changes Mar 9, 2026

View reviewed changes

DIRACGridBot marked this pull request as draft March 9, 2026 10:26

aldbr linked an issue Mar 18, 2026 that may be closed by this pull request

Document gubbins-charts #659

Open

fstagni reviewed Mar 19, 2026

View reviewed changes

fix: minor fixes to the release process

4f9c046

fstagni marked this pull request as ready for review March 24, 2026 12:45

docs: update release docs

7ed64ab


		## diracx release

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


		# How to make a new DiracX release

		1. Merge any PR you want in your release

Conversation

chaen commented Jan 19, 2026

Uh oh!

Uh oh!

read-the-docs-community bot commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

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

edited

Loading