Add support for `fixed` packages by Andarist · Pull Request #690 · changesets/changesets

Andarist · 2021-12-04T10:31:48Z

This introduces an alternative to the linked mode. Linked mode is being constantly misunderstood and confuses people while the fixed mode is known from other tools (like Lerna).

TODO:

add changesets per affected package
verify if there are any missing essential tests
verify how this works with generating changelogs
docs - I think this might come in a follow up PR

closes #581
closes #570

changeset-bot · 2021-12-04T10:31:50Z

🦋 Changeset detected

Latest commit: 107d706

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@changesets/types	Minor
@changesets/cli	Minor
@changesets/config	Minor
@changesets/assemble-release-plan	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Andarist · 2021-12-04T10:33:18Z

packages/assemble-release-plan/src/index.test.ts

    expect(releases[1].newVersion).toEqual("1.0.1");
    expect(releases[1].changesets).toEqual([]);
  });
+  it("should update multiple dependents of a single package", () => {


those two tests previously had been configuring linked but that wasn't relevant for them so I've moved them to the top block~

Andarist · 2021-12-04T10:33:55Z

packages/assemble-release-plan/src/index.test.ts

    expect(releases[0].name).toEqual("pkg-a");
    expect(releases[0].newVersion).toEqual("2.0.0");
  });
-  it("should assemble release plan for linked packages", () => {


I've grouped tests related to the linked packages in a describe block - no significant changes were made to those moved tests

Andarist · 2021-12-04T10:34:29Z

packages/cli/src/commands/version/version.test.ts

    });
  });

-  it("should bump packages to the correct versions when packages are linked", async () => {


similarly here - I've moved tests related to linked packages to their own block

emmatown · 2021-12-07T22:29:49Z

__fixtures__/fixed-packages/.changeset/config.js

@@ -0,0 +1,87 @@
+/*


This config doesn't actually work, right? Since it's a js file

I have no idea - I've just copied the linked-packages fixtures and modified it slightly. I will verify tomorrow if this can be removed.

emmatown

The option seems fine to me. Def curious to see what the changelog looks like. We might even want changelog generators to have a separate export to define what we say in the case of "this package hasn't changed at all but it's being released so all the versions are the same"

Andarist · 2021-12-07T23:22:51Z

The option seems fine to me. Def curious to see what the changelog looks like. We might even want changelog generators to have a separate export to define what we say in the case of "this package hasn't changed at all but it's being released so all the versions are the same"

Definitely lots to discuss when it comes to the changelog generation stuff - I will reach out to you in the coming days to talk this through further, but in the meantime you could take a look at this: #683 . I have some new ideas/thoughts on this issue - but the use cases mentioned there are still relevant.

fivethreeo · 2022-02-03T01:53:08Z

What is the status of this pull? Would it be possible to try this now if I install changesets from the branch?

Andarist · 2022-02-05T13:38:49Z

@fivethreeo I'm waiting for review and need to recheck the todo list added in the thread.

You can try it out by installing this build:

yarn add --dev @changesets/cli@https://pkg.csb.dev/changesets/changesets/commit/98401c27/@changesets/cli/_pkg.tgz

emmatown · 2022-02-06T23:41:52Z

packages/assemble-release-plan/src/utils.ts

+      case "minor":
+        highestReleaseType = "minor";
+        break;
+      // patch never needs to override another value


Wouldn't patch need to override a none?

Yep, you are right. none releases never actually get here - we only with releases that will actually be released here. However, this util is quite generic so better to handle all the cases now than to be sorry later. Going to push a fix for this in a sec.

emmatown · 2022-02-06T23:53:24Z

A test that generates a changelog would be great (I imagine for something being bumped that didn't have any changesets it would just have the version and nothing else?)

# Conflicts: # packages/apply-release-plan/src/index.test.ts # packages/assemble-release-plan/src/apply-links.ts # packages/assemble-release-plan/src/index.test.ts # packages/cli/src/commands/version/version.test.ts # packages/config/src/index.ts

codesandbox-ci · 2022-02-13T17:27:18Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 107d706:

Sandbox	Source
Vanilla	Configuration

… that dont have any changeset associated with them

Andarist · 2022-02-13T17:46:58Z

@mitchellhamilton just added such a test. I think that an "empty" entry is acceptable for now - we should gather feedback from users before introducing more options. It is very likely that most people who want the fixed mode might want aggregate changelogs (#683) and this would "solve" this problem without adding new functions to changelog generators.

See changesets/changesets#690 for more infos

Andarist requested a review from emmatown December 4, 2021 10:31

Andarist commented Dec 4, 2021

View reviewed changes

Andarist force-pushed the fixed-packages branch from 2efa76c to a73cec9 Compare December 4, 2021 10:37

Add support for fixed packages

29633c2

Andarist force-pushed the fixed-packages branch from a73cec9 to 29633c2 Compare December 4, 2021 10:40

This was referenced Dec 4, 2021

Mixed versions across workspaces #581

Closed

linked config setting not working as expected? #570

Closed

emmatown reviewed Dec 7, 2021

View reviewed changes

Add changesets

a00ba25

This was referenced Dec 17, 2021

Generate changelogs without bumping version #595

Open

Add a flag to allow skipping Github release creation changesets/action#108

Closed

This was referenced Jan 13, 2022

UIAPPS-104 Create a UI Extensions react package DataDog/apps#94

Merged

UIAPPS-104 Link UI Extensions packages DataDog/apps#97

Merged

Delete config.js

4497981

emmatown reviewed Feb 6, 2022

View reviewed changes

Merge branch 'main' into fixed-packages

8d986f4

# Conflicts: # packages/apply-release-plan/src/index.test.ts # packages/assemble-release-plan/src/apply-links.ts # packages/assemble-release-plan/src/index.test.ts # packages/cli/src/commands/version/version.test.ts # packages/config/src/index.ts

Andarist added 2 commits February 13, 2022 18:34

Tweak getHighestReleaseType implementation

35eaa93

Add a test showcasing how CHANGELOGs are generated for fixed packages…

107d706

… that dont have any changeset associated with them

emmatown approved these changes Feb 13, 2022

View reviewed changes

Andarist merged commit 27a5a82 into main Feb 13, 2022

Andarist deleted the fixed-packages branch February 13, 2022 23:21

github-actions bot mentioned this pull request Feb 13, 2022

Version Packages #750

Merged

Andarist mentioned this pull request Feb 13, 2022

Add docs for the fixed mode #754

Closed

jplhomer mentioned this pull request Feb 23, 2022

Use changesets for changelogs, versioning and releases Shopify/hydrogen-v1#744

Merged

3 tasks

akphi mentioned this pull request Feb 24, 2022

minor fixes finos/legend-studio#883

Merged

8 tasks

sebald added a commit to marigold-ui/marigold that referenced this pull request Mar 3, 2022

chore: use fixed versioning for system and components package

813212c

See changesets/changesets#690 for more infos

sebald mentioned this pull request Mar 3, 2022

chore: use fixed versioning for system and components package marigold-ui/marigold#1828

Merged

Conversation

Andarist commented Dec 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Dec 4, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Andarist Dec 4, 2021

Choose a reason for hiding this comment

Uh oh!

Andarist Dec 4, 2021

Choose a reason for hiding this comment

Uh oh!

Andarist Dec 4, 2021

Choose a reason for hiding this comment

Uh oh!

emmatown Dec 7, 2021

Choose a reason for hiding this comment

Uh oh!

Andarist Dec 7, 2021

Choose a reason for hiding this comment

Uh oh!

emmatown left a comment

Choose a reason for hiding this comment

Uh oh!

Andarist commented Dec 7, 2021

Uh oh!

fivethreeo commented Feb 3, 2022

Uh oh!

Andarist commented Feb 5, 2022

Uh oh!

emmatown Feb 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Andarist Feb 13, 2022

Choose a reason for hiding this comment

Uh oh!

emmatown commented Feb 6, 2022

Uh oh!

codesandbox-ci bot commented Feb 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Andarist commented Feb 13, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Andarist commented Dec 4, 2021 •

edited

Loading

changeset-bot bot commented Dec 4, 2021 •

edited

Loading

emmatown Feb 6, 2022 •

edited

Loading

codesandbox-ci bot commented Feb 13, 2022 •

edited

Loading