You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/admin/how-to/make-a-release.md
+25Lines changed: 25 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,31 @@ Execute the following points in the presented order.
25
25
26
26
At this stage, there is a new `diracx` and `diracx-chart` release.
27
27
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)
- 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
+
28
53
## Making the extension release
29
54
30
55
Making a release of an extension depends on how the extension has been set up. Below are recommended workflows:
Copy file name to clipboardExpand all lines: docs/admin/reference/making-releases.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,11 @@ flowchart LR
52
52
53
53
## diracx release
54
54
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.
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
+
72
91
## diracx-charts releases
73
92
74
93
Every commit in master triggers a new release. The releases are published on a [helm repo](https://charts.diracgrid.org/index.yaml)
0 commit comments