Skip to content

Local Environment: Follow Semantic Versioning and include release notes when publishing #31

Open

Description

@danielbachhuber

Due to how the repository is set up, all packages are published at the same time with the same version number:

To publish the wp-now package to npm, you must first understand the automated release process facilitated by lerna. This process includes automatically incrementing the version number, creating a new tag, and publishing all modified packages to npm simultaneously. Notably, all published packages share the same version number.

To the end user of wp-now, the package version number will seem somewhat random. It may receive a major version change when some other package receives a breaking change.

Previously WordPress/wordpress-playground#340 (comment)

Done is:

  • We have a clear Semantic Versioning publishing policy.
  • We publish release notes when tagging new versions, so users can easily see what changes between versions.

Activity

  1. adamziel commented on May 16, 2023

    @adamziel
    Collaborator

    Using separate versions for each package in a monorepo gets very messy very quickly, as outlined in WordPress/gutenberg#46693. It is very convenient to advance versions of all packages in a monorepo together, even if that means an occasional version bump that has no merit on its own. It is a trade-off, but one with an overwhelming amount of benefits – see the discussion and this comment from @noahtallen and this comment from @jsnajdr.

    I'm not against semantic versioning in wp-now, but I'd consider a separate repository – even if it would contain just a shell package for publishing purposes.

  2. danielbachhuber commented on May 16, 2023

    @danielbachhuber
    MemberAuthor

    We can wait and see what sort of feedback we get.

  3. noahtallen commented on May 17, 2023

    @noahtallen
    Member

    I think that mostly matters when you have a ton of packages which all depend on each other, and you have to install a lot of them in the same project. (Which definitely describes most of the editor packages!) But something like wp-env is semantically versioned with a changelog, and that wouldn't need to match the other @wordpress/ packages.

    It just gets so easy have implicit dependencies. If you need to install both package A and B, and A starts relying on a new feature in package B -- but at the same time, package B doesn't work if there are two copies of it at runtime -- things will break. Then you do need to update both simultaneously or you'll break things. That relationship is hard to encode with versioning, but it's more straightforward to manage when it's just "ahh everything needs to on the same version"

    I have no clue how that applies to wp-now though!

  4. adamziel commented on May 17, 2023

    @adamziel
    Collaborator

    Thank you @noahtallen! The VS code extension depends on wp-now and I anticipate more such packages. There are good reasons to import both wp-now and other packages from this repo - e.g. TypeScript types for Blueprints and PHP.

    Here's the current project graph, to visualise how hard it would be to maintaining separate versions of interdependent packages:

    CleanShot 2023-05-17 at 09 51 52@2x

    How about splitting wp-now in two different packages?

    • wp-now, the library – uses the pinned monorepo version, can be imported by other packages.
    • wp-now, the executable – uses semantic versioning, nothing imports it, gets bundled and shipped to npm with no dependencies on other packages. Just like @wp-playground/client:
    CleanShot 2023-05-17 at 09 55 00@2x
  5. noahtallen commented on May 17, 2023

    @noahtallen
    Member

    Oh, that reminds me about executables and npx. For example, if I wanted to run wp-env through npx without installing it, you'd have to do npx @wordpress/env start, which is kind of weird. (Or for this project, npx @wp-now/wp-now) So maybe it makes sense to publish the wp-now executable without the namespace?

  6. danielbachhuber commented on May 17, 2023

    @danielbachhuber
    MemberAuthor

    How about splitting wp-now in two different packages?

    I'd be fine with this approach (as long as it isn't a total mess)

    So maybe it makes sense to publish the wp-now executable without the namespace?

    How do we do this if https://www.npmjs.com/package/wp-now already exists?

  7. noahtallen commented on May 17, 2023

    @noahtallen
    Member

    How do we do this if https://www.npmjs.com/package/wp-now already exists?

    🙃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions