Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List package versions in releases for monorepos with independent versioning #79

Merged
merged 6 commits into from
Jun 26, 2023

Conversation

mcmire
Copy link
Contributor

@mcmire mcmire commented Jun 23, 2023

Currently, the notes for a independently-versioned monorepo release lists all of the packages that are included in that release, but does not list the versions of those packages that are being published. This makes reviewing past releases difficult as we have to cross-reference package tags with monorepo tags to determine those versions.

This commit fixes that. For instance, instead of seeing the following for a GitHub release:

59.0.0

@metamask/base-controller

(release notes for base-controller)

@metamask/controller-utils

(release notes for controller-utils)

we should now see:

59.0.0

@metamask/base-controller 4.0.0

(release notes for base-controller)

@metamask/controller-utils 5.0.0

(release notes for controller-utils)

Currently, the notes for a monorepo release lists all of the packages
that are included in that release, but does not list the versions of
those packages that are being published. This makes reviewing past
releases difficult as we have to cross-reference package tags with
monorepo tags to determine those versions.

This commit fixes that. For instance, instead of seeing the following
for a GitHub release:

> # 59.0.0
>
> ## @metamask/base-controller
>
> (release notes for base-controller)
>
> ## @metamask/controller-utils
>
> (release notes for controller-utils)

we should now see:

> # 59.0.0
>
> ## @metamask/base-controller 4.0.0
>
> (release notes for base-controller)
>
> ## @metamask/controller-utils 5.0.0
>
> (release notes for controller-utils)
@mcmire mcmire requested a review from a team as a code owner June 23, 2023 18:01
Copy link
Member

@Mrtenz Mrtenz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we only do this when the repo is using independent versioning?

@mcmire
Copy link
Contributor Author

mcmire commented Jun 23, 2023

@Mrtenz Yeah, that makes more sense. Updated in 337e18f.

@mcmire mcmire changed the title List versions for packages in monorepo releases List package versions in releases for monorepos with independent versioning Jun 23, 2023
@Gudahtt
Copy link
Member

Gudahtt commented Jun 23, 2023

Looks great! CI still failing though

@mcmire mcmire marked this pull request as draft June 23, 2023 18:55
@mcmire
Copy link
Contributor Author

mcmire commented Jun 23, 2023

I've fixed CI on this PR: #80

@mcmire
Copy link
Contributor Author

mcmire commented Jun 26, 2023

I've tested this on a monorepo with independent versions (core), a monorepo with fixed versions (snaps), and a polyrepo (utils), and all of them seemed to work as designed. Here are the resulting GitHub releases:

@mcmire mcmire marked this pull request as ready for review June 26, 2023 20:58
Copy link
Member

@Gudahtt Gudahtt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mcmire mcmire merged commit 59765eb into main Jun 26, 2023
@mcmire mcmire deleted the add-versions-to-monorepo-packages branch June 26, 2023 23:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants