Skip to content

Commit 6c483c7

Browse files
committed
chore: complete release docs with release-please
1 parent b75ed01 commit 6c483c7

3 files changed

Lines changed: 47 additions & 3 deletions

File tree

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,31 @@ Execute the following points in the presented order.
2525

2626
At this stage, there is a new `diracx` and `diracx-chart` release.
2727

28+
# How to make a new DiracX-Web release
29+
30+
Execute the following points in the presented order.
31+
32+
1. Find the `release-please` [pull request](https://github.com/DIRACGrid/diracx-web/pulls?q=is%3Apr+is%3Aopen+%22chore%28main%29%3A+release%22) for your release. If you can't find it, it means that the currently existing latest release includes already all code changes.
33+
34+
2. Review the release number **and** the content of the changelog
35+
36+
- If you need to change the release number, follow the [`release-please` doc](https://github.com/googleapis/release-please?tab=readme-ov-file#how-do-i-change-the-version-number)
37+
38+
```bash
39+
git commit --allow-empty -m "chore: release 0.0.3" -m "Release-As: v0.0.3"
40+
git push upstream HEAD:main
41+
```
42+
43+
- If you want to update the release notes manually, follow the [`release-please` doc](https://github.com/googleapis/release-please?tab=readme-ov-file#how-can-i-fix-release-notes)
44+
45+
3. Merge the `release-please` PR
46+
47+
4. Check the [deployment action](https://github.com/DIRACGrid/diracx-web/actions/workflows/deployment.yml?query=event%3Apush)
48+
49+
5. When the above is finished, check that the [CI](https://github.com/DIRACGrid/diracx-charts/actions/workflows/chart-ci.yml) in `diracx-charts` is successful
50+
51+
At this stage, there is a new `diracx-web` release and `diracx-chart` release.
52+
2853
## Making the extension release
2954
3055
Making a release of an extension depends on how the extension has been set up. Below are recommended workflows:
Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,11 @@ flowchart LR
5252

5353
## diracx release
5454

55-
Releases are managed by `ReleasePlease`. The token used to perform it belongs to `diracbot` github user
55+
Releases are managed by `ReleasePlease`. The token used to perform it belongs to `DIRACGridBot` github user.
56+
57+
!!! info "Why a bot token?"
58+
59+
`GITHUB_TOKEN` cannot trigger downstream workflows (GitHub's anti-loop protection). Using a bot PAT ensures that the tag created by `release-please` triggers the deployment and chart update jobs.
5660

5761
A new release creates:
5862

@@ -69,6 +73,21 @@ git commit --allow-empty -m "chore: release 0.0.3" -m "Release-As: v0.0.3"
6973
git push upstream HEAD:main
7074
```
7175

76+
## diracx-web release
77+
78+
Releases are managed by `ReleasePlease`. The token used to perform it belongs to `DIRACGridBot` github user, same as `diracx`.
79+
80+
!!! info "Why a bot token?"
81+
82+
`GITHUB_TOKEN` cannot trigger downstream workflows (GitHub's anti-loop protection). Using a bot PAT ensures that the tag created by `release-please` triggers the deployment and chart update jobs.
83+
84+
A new release creates:
85+
86+
- a [github release](https://github.com/DIRACGrid/diracx-web/releases)
87+
- an [npm release](https://www.npmjs.com/package/@dirac-grid/diracx-web-components) for `diracx-web-components`
88+
- new [docker images](https://github.com/DIRACGrid/diracx-web/)
89+
- updated [Storybook documentation](https://diracgrid.github.io/diracx-web/) on GitHub Pages
90+
7291
## diracx-charts releases
7392

7493
Every commit in master triggers a new release. The releases are published on a [helm repo](https://charts.diracgrid.org/index.yaml)

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ nav:
9292
- Debugging: admin/how-to/debugging.md
9393
- Upgrading: admin/how-to/upgrading.md
9494
- Rotate a secret: admin/how-to/rotate-a-secret.md
95-
- Make a release: dev/how-to/make-a-release.md
95+
- Make a release: admin/how-to/make-a-release.md
9696
- Explanations:
9797
- admin/explanations/index.md
9898
- Auth in DiracX: admin/explanations/auth-with-diracx.md
@@ -112,7 +112,7 @@ nav:
112112
- Security Model: admin/reference/security_model.md
113113
- Settings and Preferences: admin/reference/settings-and-preferences.md
114114
- Environment variables: admin/reference/env-variables.md
115-
- Making and deploying releases: dev/reference/making-releases.md
115+
- Making and deploying releases: admin/reference/making-releases.md
116116
- Charts values: admin/reference/values.md
117117
- RUN_PROD.md
118118
- SSO.md

0 commit comments

Comments
 (0)