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

Add CPM scenario for NU1604 #3320

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

martinrrm
Copy link
Contributor

Fix: NuGet/Home#13500

Added the scenario for users using CPM and NU1604 is raised.

@martinrrm martinrrm requested review from a team as code owners July 22, 2024 16:34
Copy link

Learn Build status updates of commit 2c6d7c8:

💡 Validation status: suggestions

File Status Preview URL Details
docs/reference/errors-and-warnings/NU1604.md 💡Suggestion View Details

docs/reference/errors-and-warnings/NU1604.md

  • Line 36, Column 10: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

which implies a lower bound.

> [!Note]
> When using CPM and the file `Directory.Packages.Props` is invalid, NU1604 is raised.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added this because the original issue is related to an invalid file but makes me think this is a bug instead of a docs issue. @jeffkl what do you think?

@@ -32,3 +32,22 @@ or
> `<PackageReference Version="9.0.0" />`

which implies a lower bound.

If using [Central Package Managment](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management) you will need to update the `PackageVersion` `Version` attribute in your `Directory.Packages.Props` file.
Copy link
Member

Choose a reason for hiding this comment

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

Normally this would be a different scenario.

We'd have another Issue, Solution etc.

We should also call out that this is a special case, since in a properly onboarded CPM scenario, you'd get NU1008.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wasn't sure if I should put it in another Solution section since it's the same error but yeah it's a special case so I can start with that

Copy link
Member

@nkolev92 nkolev92 Jul 22, 2024

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

When CPM is enabled, is the warning/error message the same, or different?

If the warning/error message is different when CPM is enabled compared to when it's not, it's important to have a sample of the message in these docs so that if the customer searches those words, they're more likely to find these docs.

@@ -32,3 +32,22 @@ or
> `<PackageReference Version="9.0.0" />`

which implies a lower bound.

If using [Central Package Managment](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management) you will need to update the `PackageVersion` `Version` attribute in your `Directory.Packages.Props` file.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: my readability preference would be for something between these two words..

Suggested change
If using [Central Package Managment](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management) you will need to update the `PackageVersion` `Version` attribute in your `Directory.Packages.Props` file.
If using [Central Package Managment](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management) you will need to update the `PackageVersion` element's `Version` attribute in your `Directory.Packages.Props` file.


> `<PackageVersion Include="PackageA" Version="(9.0.0, )" />`


Copy link
Contributor

Choose a reason for hiding this comment

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

extra blank line

@@ -32,3 +32,22 @@ or
> `<PackageReference Version="9.0.0" />`

which implies a lower bound.

If using [Central Package Managment](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management) you will need to update the `PackageVersion` `Version` attribute in your `Directory.Packages.Props` file.
For example change from:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For example change from:
For example, change from:

@@ -32,3 +32,22 @@ or
> `<PackageReference Version="9.0.0" />`

which implies a lower bound.

If using [Central Package Managment](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management) you will need to update the `PackageVersion` `Version` attribute in your `Directory.Packages.Props` file.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If using [Central Package Managment](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management) you will need to update the `PackageVersion` `Version` attribute in your `Directory.Packages.Props` file.
If using [Central Package Managment](https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management), you will need to update the `PackageVersion` `Version` attribute in your `Directory.Packages.Props` file.

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.

Mention existence of Central Package Management on page for NU1604
4 participants