fix: Use strategies for workspace plugins. #2112

kinyoklion · 2023-11-03T22:51:39Z

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Fixes #1978, #2089 and maybe #2109 🦕

The main goal here is to generate a base pull request using the strategy defined for the release. Then add to that the updates that are needed specifically to the workspace. This will result in generating the correct changelog header as well as updating "extra-files".

I need to implement tests for this yet, but I wanted to get some opinions on the approach before piling too much code on. I've only made changes for the node workspace, but the concept could be extended to to the other workspace plugins.

Example pr created with these changes showing fixes for #1978 #2089:
https://github.com/kinyoklion/release-please-monorepo-tests/pull/10/files

google-cla · 2023-11-03T22:51:43Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

kinyoklion · 2023-11-03T22:52:35Z

src/plugins/node-workspace.ts

+    const strategy = this.strategiesByPath[updatedPackage.location];
+    const latestRelease = this.releasesByPath[updatedPackage.location];
+
+    const basePullRequest = strategy


Make a base pull request that contains the "extra-files" updaters as well as the changelog header.

src/plugins/node-workspace.ts

kinyoklion · 2023-11-03T22:54:17Z

src/strategies/base.ts

@@ -254,19 +254,19 @@ export abstract class BaseStrategy implements Strategy {
    commits: ConventionalCommit[],
    latestRelease?: Release,
    draft?: boolean,
-    labels: string[] = []
+    labels: string[] = [],
+    bumpOnlyOptions?: BumpReleaseOptions


I needed some indicator to bypass all the early out conditions associated with no commits or changelog entries.

An alternate approach to this whole thing may be to generate all the PRs always, and then prune ones we don't want.

kinyoklion · 2023-11-03T22:57:58Z

src/plugins/node-workspace.ts

-      headRefName: BranchName.ofTargetBranch(this.targetBranch).toString(),
+      headRefName:
+        basePullRequest?.headRefName ??
+        BranchName.ofTargetBranch(this.targetBranch).toString(),


chingor13

Thank you for this and apologies for the late review.

In general I think this is a fine approach, although I don't fully understand the edge cases you are trying to handle. Test case would demonstrate the primary scenario it's fixing and prevent regressions in the future. Test cases would also demonstrate the edge cases you're trying to handle.

chingor13 · 2023-12-13T22:32:49Z

src/strategy.ts

@@ -47,7 +51,8 @@ export interface Strategy {
    commits: Commit[],
    latestRelease?: Release,
    draft?: boolean,
-    labels?: string[]
+    labels?: string[],
+    bumpOnlyOptions?: BumpReleaseOptions


I'm a bit unclear on what these options are for. Perhaps a docstring is good enough to describe what it's use is for.

Yes, I will add some documentation.

I wasn't 100% sure on this, but basically these serve as an indicator that you are creating a release with a version number update, even if there were no associated conventional commits.

So it is:
A: An indicator that we want to make a release even though there are no calculated changes.
B: The version number we want for that release.

kinyoklion · 2023-12-13T23:37:45Z

Thank you for this and apologies for the late review.

In general I think this is a fine approach, although I don't fully understand the edge cases you are trying to handle. Test case would demonstrate the primary scenario it's fixing and prevent regressions in the future. Test cases would also demonstrate the edge cases you're trying to handle.

Thank you @chingor13,

Now that I know the general approach is fine I will add some test cases that make this more clear.

The situation is not really an edge case. If you have any workspace dependent packages, then it doesn't generate change logs correctly or update files with version numbers.

Imagine you have two packages. Package A and package B. Package B depends on package A.

You commit a change which affects files in package A: "feat: Add my feature."

The release PR that gets generated will have an incorrect changelog. It will just append a "dependencies" section to the top of the changelog.

Example:

The second major problem is that if package B had any extra-files, then the version numbers in those files would not be updated.

In the PR I used as an example the demo-extra-files.md would not have the version number update as things currently work.

Both of these are because version bumps only from dependencies do not run any of the steps associated with the base strategy being used.

Thank you,
Ryan

…elease-please into rlamb/fix-workspace-base-pr

kinyoklion · 2023-12-15T22:15:49Z

__snapshots__/node-workspace.js

+
+<details><summary>@here/pkgB: 2.2.3</summary>
+
+## [2.2.3](https://github.com/googleapis/node-test-repo/compare/pkgB-v2.2.2...pkgB-v2.2.3) (1983-10-10)


This line here represents one of the primary differences. Without this change, there would be no header line here. Both in the PR and in the Changelog.

kinyoklion · 2023-12-15T22:16:11Z

__snapshots__/node-workspace.js

+other notes
+`
+
+exports['NodeWorkspace plugin run includes headers for packages with configured strategies 3'] = `


This demonstrates the correct header line being added to the changelog.

kinyoklion · 2023-12-15T22:16:47Z

__snapshots__/node-workspace.js

+`
+
+exports['NodeWorkspace plugin run includes headers for packages with configured strategies 5'] = `
+## 1.1.2 (2023-12-15)


This also would not have been present. This doesn't include a diff, because it didn't have the previous version information included.

kinyoklion · 2023-12-15T22:17:33Z

test/plugins/node-workspace.ts

+      expect(nodeCandidate).to.not.be.undefined;
+      const updates = nodeCandidate!.pullRequest.updates;
+
+      assertHasUpdate(updates, 'node2/my-file', Generic);


Without invoking the base strategy we would not have the update for extra-files.

kinyoklion · 2023-12-15T22:18:39Z

I've added some additional doc comments, added tests, and made some comments in the PR for those tests.

In this PR I am only focusing on node, but I believe that these same problems likely affect the other workspace plugins.

kinyoklion · 2023-12-21T00:01:09Z

~~I found some situation where the changelog is still not correct, so I am investigating that and will update.~~

Resolved by using updateCandidate after making the base request.

TimothyJones · 2023-12-25T03:13:42Z

I am certain this would fix #2109.

In addition to the issues you mentioned, I think this might also fix #1946, or at least address one of the issues that contributes to it.

fix: Use strategies for workspace plugins.

277821b

kinyoklion requested review from a team as code owners November 3, 2023 22:51

blunderbuss-gcf bot assigned chingor13 Nov 3, 2023

product-auto-label bot added the size: m Pull request size is medium. label Nov 3, 2023

kinyoklion commented Nov 3, 2023

View reviewed changes

src/plugins/node-workspace.ts Outdated Show resolved Hide resolved

kinyoklion commented Nov 3, 2023

View reviewed changes

Merge branch 'main' into rlamb/fix-workspace-base-pr

39a2415

chingor13 requested changes Dec 13, 2023

View reviewed changes

kinyoklion added 7 commits December 14, 2023 10:34

Merge branch 'main' into rlamb/fix-workspace-base-pr

6f9af54

fix: Include dependencies header.

5648538

Add test for changelog entries and PR for headers.

cc25227

Extend test to include comparison link.

f9b38c1

Add extra-files test.

3707bb8

Remove commented out code.

0d5d844

Merge branch 'rlamb/fix-workspace-base-pr' of github.com:kinyoklion/r…

cd9666f

…elease-please into rlamb/fix-workspace-base-pr

product-auto-label bot added size: l Pull request size is large. and removed size: m Pull request size is medium. labels Dec 15, 2023

Add missing config for test.

9ca04c5

kinyoklion commented Dec 15, 2023

View reviewed changes

kinyoklion requested a review from chingor13 December 15, 2023 22:18

Use updateCandidate when a base pull request can be created.

c8a9503

chingor13 approved these changes Dec 28, 2023

View reviewed changes

chingor13 added 2 commits December 28, 2023 12:46

Merge branch 'main' into rlamb/fix-workspace-base-pr

8459bc8

test: use date safe snapshot

c8e1e15

chingor13 merged commit de4088b into googleapis:main Dec 28, 2023
11 checks passed

release-please bot mentioned this pull request Dec 28, 2023

chore(main): release 16.6.0 #2179

Merged

This was referenced Feb 23, 2024

Changelog doesn't include version header for workspace dependency bumps #2089

Closed

node-workspaces plugin creates inconsistent changelog and release name #1530

Closed

This was referenced Jun 20, 2024

cargo-workspace - package missing version header in changelog when only dependency is updated #2318

Closed

fix: use strategies for cargo workspace plugin (rust) #2320

Merged

WontonSam mentioned this pull request Sep 16, 2024

[Snyk] Upgrade: jsonwebtoken, , , release-please WontonSam/repo-automation-bots#490

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Use strategies for workspace plugins. #2112

fix: Use strategies for workspace plugins. #2112

kinyoklion commented Nov 3, 2023 •

edited

Loading

google-cla bot commented Nov 3, 2023

kinyoklion Nov 3, 2023

kinyoklion Nov 3, 2023

kinyoklion Nov 3, 2023

chingor13 left a comment

chingor13 Dec 13, 2023

kinyoklion Dec 13, 2023

kinyoklion commented Dec 13, 2023 •

edited

Loading

kinyoklion Dec 15, 2023

kinyoklion Dec 15, 2023

kinyoklion Dec 15, 2023

kinyoklion Dec 15, 2023

kinyoklion commented Dec 15, 2023

kinyoklion commented Dec 21, 2023 •

edited

Loading

TimothyJones commented Dec 25, 2023


		<details><summary>@here/pkgB: 2.2.3</summary>

		## [2.2.3](https://github.com/googleapis/node-test-repo/compare/pkgB-v2.2.2...pkgB-v2.2.3) (1983-10-10)

fix: Use strategies for workspace plugins. #2112

fix: Use strategies for workspace plugins. #2112

Conversation

kinyoklion commented Nov 3, 2023 • edited Loading

google-cla bot commented Nov 3, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chingor13 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kinyoklion commented Dec 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kinyoklion commented Dec 15, 2023

kinyoklion commented Dec 21, 2023 • edited Loading

TimothyJones commented Dec 25, 2023

kinyoklion commented Nov 3, 2023 •

edited

Loading

kinyoklion commented Dec 13, 2023 •

edited

Loading

kinyoklion commented Dec 21, 2023 •

edited

Loading