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 MSBuildSdk as well known package type #2843

Closed
wants to merge 2 commits into from

Conversation

kant2002
Copy link

@kant2002 kant2002 commented Aug 7, 2022

No description provided.

@kant2002 kant2002 requested review from a team as code owners August 7, 2022 04:57
@opbld34
Copy link

opbld34 commented Aug 7, 2022

Docs Build status updates of commit d2627e8:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/create-packages/set-package-type.md ⚠️Warning View Details

docs/create-packages/set-package-type.md

  • Line 22, Column 39: [Warning: hard-coded-locale - See documentation] Link 'https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 22, Column 39: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/en-us/visualstudio/msbuild/how-to-use-project-sdk' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings 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:

@opbld34
Copy link

opbld34 commented Aug 7, 2022

Docs Build status updates of commit 60b621f:

✅ Validation status: passed

File Status Preview URL Details
docs/create-packages/set-package-type.md ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@kant2002
Copy link
Author

kant2002 commented Aug 7, 2022

I assume https://review.docs.microsoft.com/en-us/help/onboard/faq link is for MS only. Maybe if there nothing special, would be good to have that link public.

@@ -19,6 +19,8 @@ Packages can be marked with one more more *package types* to indicate its intend

- `Template` type packages provide [custom templates](/dotnet/core/tools/custom-templates) that can be used to create files or projects like an app, service, tool, or class library.

- `MSBuildSdk` type packages provides [MSBuild SDK](/visualstudio/msbuild/how-to-use-project-sdk) that can be used to augment behaviour of projects. Examples of such SDK can be found on [following GitHub repo](https://github.com/microsoft/MSBuildSdks).
Copy link
Member

Choose a reason for hiding this comment

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

I'm not 100% sure how I feel about this change, as while it's commonly understood what the MSBuildSDK package is, NuGet/Home#6484 is still not resolved, so if you ask the client, this isn't really known.

It's probably cheap to fix, but I just haven't had the time.

@jeffkl thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

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

quick bump for @jeffkl so we can revise or merge.

Copy link
Contributor

Choose a reason for hiding this comment

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

Its probably fine to document it and implement it later honestly. There's no enforcement as far as I know so you can put any value in there you want. At least if we document it then packages could be correct.

Copy link
Member

Choose a reason for hiding this comment

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

I'm comfortable with whatever you 2 decide. Don't block merging/changes on me :)

@JonDouglas
Copy link
Contributor

Closing this PR in favor of #3036 (simplified language)

Thank you for kicking off this contribution. We really appreciate it!

@JonDouglas JonDouglas closed this Jun 6, 2023
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.

5 participants