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

Allow packages to not go stable #3116

Merged
merged 1 commit into from
Apr 3, 2024
Merged

Conversation

joperezr
Copy link
Member

@joperezr joperezr commented Mar 23, 2024

Fixes #2541

cc: @eerhardt

With these changes, now individual projects can decide to stay marked as preview even when the rest of the repo is producing stable packages. Once we branch for GA, We will update StabilizePackageVersion and set it to true meaning that the repo will start producing stable packages. That said, individual projects will be able to stay in prerelease by adding the following property in their .csproj:

    <PropertyGroup>
        <!-- This project will remain producing prerelease versions, even when the rest of the repo is producing stable packages -->
        <SuppressFinalPackageVersion>true</SuppressFinalPackageVersion>
    </PropertyGroup>

This model is the same as the one used by dotnet/runtime repo.

Microsoft Reviewers: Open in CodeFlow

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-codeflow for labeling automated codeflow. intentionally a different color! label Mar 23, 2024
@eerhardt
Copy link
Member

https://github.com/dotnet/arcade/blob/cd27fcf3c2b5c238acd3e8d1e85bb6ef6c205686/Documentation/CorePackages/Versioning.md?plain=1#L119-L120

Some projects want to remain producing pre-release packages even if the repository is running a final stable build because
they don't ship or aren't ready to ship stable. Those projects can set SuppressFinalPackageVersion property to true.

Why wouldn't we use SuppressFinalPackageVersion? I think StabilizePackageVersion is meant to be set globally for the whole build (i.e. in a build/environment variable).

@joperezr
Copy link
Member Author

Oh, I wasn't aware of the property's existence 😋.

I'm assuming this would just work if that is set with the changes I have here, but I'll double-check.

@eerhardt
Copy link
Member

I'm assuming this would just work if that is set with the changes I have here

Agreed. I guess I was mostly commenting on the PR description above in the top post. For the libraries we don't want to go stable, we should just need to set <SuppressFinalPackageVersion>true</SuppressFinalPackageVersion> in their .csproj.

Copy link
Member

@eerhardt eerhardt left a comment

Choose a reason for hiding this comment

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

LGTM

@radical
Copy link
Member

radical commented Mar 28, 2024

For the libraries we don't want to go stable, we should just need to set <SuppressFinalPackageVersion>true</SuppressFinalPackageVersion> in their .csproj.

The PR description should be updated to reference this property.

@joperezr
Copy link
Member Author

joperezr commented Apr 3, 2024

Sorry this took a while, I have just validated that the property indeed works with these changes and packages would remain unstable.

@joperezr
Copy link
Member Author

joperezr commented Apr 3, 2024

For the libraries we don't want to go stable, we should just need to set <SuppressFinalPackageVersion>true</SuppressFinalPackageVersion> in their .csproj.

The PR description should be updated to reference this property.

Updated.

@joperezr joperezr merged commit 0ee1b4c into dotnet:main Apr 3, 2024
8 checks passed
@joperezr joperezr deleted the PreleasePackages branch April 3, 2024 22:27
@eerhardt
Copy link
Member

@joperezr - was this supposed to be backported to release/8.0? I don't see the change in that branch

@joperezr
Copy link
Member Author

You are correct, fixing that now.

@joperezr
Copy link
Member Author

/backport to release/8.0

Copy link
Contributor

Started backporting to release/8.0: https://github.com/dotnet/aspire/actions/runs/8695610684

@github-actions github-actions bot locked and limited conversation to collaborators May 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-codeflow for labeling automated codeflow. intentionally a different color!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add the ability to keep packages in preview
3 participants