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 docs for new NuGet warning NU3043 #3339

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

kartheekp-ms
Copy link
Contributor

Tracking: https://github.com/NuGet/Client.Engineering/issues/2994

Starting with .NET 9 Preview 7 and NuGet.exe 6.12, NuGet sign commands will raise a NU3043 warning if an invalid value or SHA-1 hash is passed for the certificate fingerprint option. The value must be a SHA-256, SHA-384, or SHA-512 certificate fingerprint (in hexadecimal).

@kartheekp-ms kartheekp-ms requested review from a team as code owners September 11, 2024 20:37
@kartheekp-ms kartheekp-ms enabled auto-merge (squash) September 11, 2024 20:38
Copy link

Learn Build status updates of commit 44f00ee:

💡 Validation status: suggestions

File Status Preview URL Details
docs/reference/Errors-and-Warnings.md 💡Suggestion View Details
docs/reference/errors-and-warnings/NU3043.md ✅Succeeded View

docs/reference/Errors-and-Warnings.md

  • Line 28, Column 2: [Suggestion: column-header-missing - See documentation] Column headers are required for tables. Add appropriate header text, or remove any extra table cells that cause an extra column.

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:

Copy link

Learn Build status updates of commit 7dc5a33:

💡 Validation status: suggestions

File Status Preview URL Details
docs/reference/Errors-and-Warnings.md 💡Suggestion View Details
docs/reference/errors-and-warnings/NU3043.md ✅Succeeded View

docs/reference/Errors-and-Warnings.md

  • Line 28, Column 2: [Suggestion: column-header-missing - See documentation] Column headers are required for tables. Add appropriate header text, or remove any extra table cells that cause an extra column.

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:

@zivkan
Copy link
Member

zivkan commented Sep 11, 2024

I disabled auto merge, because I want multiple people to have the opportunity to review and provide comments before it gets merged, not just the first person to review it 1 minute after the PR was created.

Comment on lines 13 to 15
`dotnet nuget sign command` - Invalid value for `--certificate-fingerprint` option. The value must be a SHA-256, SHA-384, or SHA-512 certificate fingerprint (in hexadecimal).

`NuGet.exe sign command` - Invalid value for `CertificateFingerprint` option. The value must be a SHA-256, SHA-384, or SHA-512 certificate fingerprint (in hexadecimal).
Copy link
Member

Choose a reason for hiding this comment

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

This is not using the same formatting/style that most other warning pages use.

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 updated the docs in the latest commit. Please take a look and let me know if it looks good.

> [!NOTE]
> This warning will be promoted to an error around the .NET 10 timeframe.

## Solution
Copy link
Member

Choose a reason for hiding this comment

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

All other warning pages has an ## Issue header, that explains why the warning exists, before the solution section

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great catch. Fixed in the latest commit.

Copy link

Learn Build status updates of commit 1a1b283:

💡 Validation status: suggestions

File Status Preview URL Details
docs/reference/Errors-and-Warnings.md 💡Suggestion View Details
docs/reference/errors-and-warnings/NU3043.md ✅Succeeded View

docs/reference/Errors-and-Warnings.md

  • Line 28, Column 2: [Suggestion: column-header-missing - See documentation] Column headers are required for tables. Add appropriate header text, or remove any extra table cells that cause an extra column.

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:

Copy link

Learn Build status updates of commit bfe5eaa:

💡 Validation status: suggestions

File Status Preview URL Details
docs/reference/Errors-and-Warnings.md 💡Suggestion View Details
docs/reference/errors-and-warnings/NU3043.md ✅Succeeded View

docs/reference/Errors-and-Warnings.md

  • Line 28, Column 2: [Suggestion: column-header-missing - See documentation] Column headers are required for tables. Add appropriate header text, or remove any extra table cells that cause an extra column.

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:

Copy link

Learn Build status updates of commit af2d843:

💡 Validation status: suggestions

File Status Preview URL Details
docs/reference/Errors-and-Warnings.md 💡Suggestion View Details
docs/reference/errors-and-warnings/NU3043.md ✅Succeeded View

docs/reference/Errors-and-Warnings.md

  • Line 28, Column 2: [Suggestion: column-header-missing - See documentation] Column headers are required for tables. Add appropriate header text, or remove any extra table cells that cause an extra column.

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:

Copy link

Learn Build status updates of commit 04daf90:

✅ Validation status: passed

File Status Preview URL Details
docs/reference/Errors-and-Warnings.md ✅Succeeded View
docs/reference/errors-and-warnings/NU3043.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link

Learn Build status updates of commit a044c0d:

✅ Validation status: passed

File Status Preview URL Details
docs/reference/Errors-and-Warnings.md ✅Succeeded View
docs/reference/errors-and-warnings/NU3043.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

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.

2 participants