docs: Add release please flow and config information by d3xter666 · Pull Request #1217 · UI5/cli

d3xter666 · 2025-11-26T07:34:32Z

JIRA: CPOUI5FOUNDATION-1166

Describes the release please workflow: #1215
Rendered document: https://github.com/UI5/cli/blob/31b5215547eeedef57bf5593d02e8fafd5a07d58/docs/Release-Workflow.md

coveralls · 2025-11-26T07:38:13Z

coverage: 94.661%. remained the same
when pulling 1692e9f on document-release-please
into da120c7 on main.

docs/Release-Workflow.md

docs/release-workflow-diagram.drawio

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

KlattG

LGTM

docs/release-workflow-diagram.drawio

matz3 · 2025-11-28T07:27:17Z

docs/Release-Workflow.md

+**Behavior**:
+- Scans all `package.json` files in the workspace
+- Updates `dependencies` and `devDependencies` when workspace packages are bumped
+- `merge: false` updates versions, but doesn't merge PRs automatically


What is the source of this fact about the merge flag?

Thanks!
I have updated it.

matz3 · 2025-11-28T07:29:48Z

docs/release-workflow-diagram.drawio

+                <mxCell id="note-sequential" value="&lt;b&gt;Why sequential publishing?&lt;/b&gt;&lt;br&gt;• Packages have dependencies on each other&lt;br&gt;• NPM must have dependencies available&lt;br&gt;&amp;nbsp;&amp;nbsp;before publishing dependents&lt;br&gt;• `max-parallel: 1` ensures proper ordering" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#fff9e6;strokeColor=#d6b656;dashed=1;dashPattern=3 3;align=left;spacingLeft=10;fontSize=10;" parent="1" vertex="1">
+                    <mxGeometry x="740" y="580" width="280" height="100" as="geometry"/>
+                </mxCell>
+                <mxCell id="note-cli" value="&lt;b&gt;Why CLI published last?&lt;/b&gt;&lt;br&gt;• Shrinkwrap needs all dependencies&lt;br&gt;&amp;nbsp;&amp;nbsp;to exist on npm registry&lt;br&gt;• Ensures production-only locked deps" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#fff9e6;strokeColor=#d6b656;dashed=1;dashPattern=3 3;align=left;spacingLeft=10;fontSize=10;" parent="1" vertex="1">


I don't fully understand the connection between Why CLI published last? and Ensures production-only locked deps. To me the order of publishing isn't linked to that detail. It rather sounds like an explanation for using npm shrinkwrap in the CLI.

I'll try to reword it. It's maybe confusing as, but the idea is that:

Packages must be published in a specific order, so that they are published correctly on NPM

The shrinkwrap generator uses NPM packages, so it depends on that (all packages being available on NPM)

matz3 · 2025-11-28T07:34:06Z

docs/Release-Workflow.md

+"group-pull-request-title-pattern": "release: UI5 CLI packages ${branch}"
+```
+
+**Purpose**: Defines the title format for release pull requests in monorepos


I'm not sure whether we need to repeat all the release please documentation in such detail on this page.

The interesting detail about this configuration would be the fact why we can't use the ${version} placeholder for the PR title.

I have refactored is, so now only the important information is shown

docs/Release-Workflow.md

matz3 · 2025-11-28T07:39:04Z

docs/Release-Workflow.md

+- `merge: false` updates versions, but doesn't merge PRs automatically
+
+**Known limitations**:
+- Cannot resolve circular peer dependencies (e.g., `@ui5/project` ↔ `@ui5/builder`)


The available configuration to update peer dependencies is not mentioned here. So one could assume that it just needs to be configured to update the peer dependencies. Also, linking the existing release-please issue about this problem here would be helpful.

docs/Release-Workflow.md

matz3 · 2025-11-28T07:44:12Z

docs/Release-Workflow.md

+- Types can be reordered by array position
+- Hidden types are useful for internal changes (tests, CI, etc.)
+
+**Documentation**: [Changelog Sections](https://github.com/googleapis/release-please?tab=readme-ov-file#changelog-sections)


I can't find this section when opening the link.

…tant decisions

docs: Add release please flow and config information

31b5215

d3xter666 mentioned this pull request Nov 26, 2025

ci: Refactor automated release and publishing workflows with Release Please #1215

Merged

d3xter666 requested review from a team and KlattG November 26, 2025 07:39

KlattG requested changes Nov 27, 2025

View reviewed changes

d3xter666 and others added 24 commits November 27, 2025 15:55

docs: Update docs/Release-Workflow.md

8bef2ef

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

e6e5f01

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

78f7b9b

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

683c488

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

0958c92

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/release-workflow-diagram.drawio

b6b7e0a

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/release-workflow-diagram.drawio

9350db4

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/release-workflow-diagram.drawio

18456c3

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/release-workflow-diagram.drawio

f86a32b

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

f261620

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/release-workflow-diagram.drawio

52ce1c7

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/release-workflow-diagram.drawio

f5deca5

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

82d4924

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

01d2d31

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

dc7de69

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

132fac0

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

5574cab

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

1aa7828

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

be1eed2

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

94d7b36

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

94d8f83

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

e9a3fac

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

f8546d6

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

ea8f43a

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

d3xter666 and others added 17 commits November 27, 2025 16:48

docs: Update docs/Release-Workflow.md

2da980a

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

9f64145

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

ea162df

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

aa31c33

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

d9b17f6

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

2b9a674

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

42e784d

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

bec91cb

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

4aea030

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

5327594

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

72edb08

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

deac4a9

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

da108bc

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

1859b2f

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

d3f308f

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

docs: Update docs/Release-Workflow.md

8afeda2

Co-authored-by: Günter Klatt <57760635+KlattG@users.noreply.github.com>

fix: Rebuild diagram

bde8f3c

d3xter666 requested a review from KlattG November 27, 2025 14:57

KlattG previously approved these changes Nov 27, 2025

View reviewed changes

matz3 reviewed Nov 28, 2025

View reviewed changes

refactor: Rebuild diagram with corrections

791ea99

d3xter666 dismissed KlattG’s stale review via 791ea99 November 28, 2025 08:06

d3xter666 added 4 commits November 28, 2025 10:26

refactor: Do not apply 1:1 release please config, but stress on impor…

656dede

…tant decisions

fix: Remove redundant shrinkwrap in confg

b7aac43

refactor: Documentation

a394c4a

refactor: Update diagram

1692e9f

d3xter666 force-pushed the document-release-please branch from f71c619 to 1692e9f Compare November 28, 2025 09:29

matz3 approved these changes Nov 28, 2025

View reviewed changes

d3xter666 merged commit 46caf3b into main Nov 28, 2025
30 checks passed

d3xter666 deleted the document-release-please branch November 28, 2025 13:33

Conversation

d3xter666 commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

KlattG left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

d3xter666 commented Nov 26, 2025 •

edited

Loading

coveralls commented Nov 26, 2025 •

edited

Loading