Skip to content

Add package README for Microsoft.Azure.Functions.Worker.Sdk#3357

Merged
jviau merged 2 commits intoAzure:mainfrom
MO2k4:feature/sdk-package-readme
Apr 16, 2026
Merged

Add package README for Microsoft.Azure.Functions.Worker.Sdk#3357
jviau merged 2 commits intoAzure:mainfrom
MO2k4:feature/sdk-package-readme

Conversation

@MO2k4
Copy link
Copy Markdown
Contributor

@MO2k4 MO2k4 commented Apr 9, 2026

Summary

  • Adds a README.md to the Microsoft.Azure.Functions.Worker.Sdk package so NuGet/Visual Studio displays documentation instead of "no README available"
  • Wires the README into the .nupkg via PackageReadmeFile and a Content item in Sdk.csproj
  • README covers what the SDK provides: build/publish targets, source generators, analyzers (with diagnostic IDs), and user-configurable MSBuild properties

Closes #3249

Test plan

  • dotnet build sdk/Sdk/Sdk.csproj succeeds
  • dotnet pack sdk/Sdk/Sdk.csproj produces a .nupkg containing README.md at the package root

@jviau
Copy link
Copy Markdown
Contributor

jviau commented Apr 16, 2026

/azp run dotnet-worker.public

@azure-pipelines
Copy link
Copy Markdown

Azure Pipelines successfully started running 1 pipeline(s).

@jviau
Copy link
Copy Markdown
Contributor

jviau commented Apr 16, 2026

Thank you for your contribution @MO2k4

@jviau jviau merged commit efbc150 into Azure:main Apr 16, 2026
10 checks passed
@MO2k4 MO2k4 deleted the feature/sdk-package-readme branch April 16, 2026 17:05
Comment thread sdk/Sdk/README.md
| AZFW0009 | Error | `SupportsDeferredBinding` applied to an output binding |
| AZFW0010 | Warning | Parameter type not supported by the binding attribute |
| AZFW0011 | Error | Blob container path requires an iterable type or `BlobContainerClient` |

Copy link
Copy Markdown

@Frulfump Frulfump Apr 16, 2026

Choose a reason for hiding this comment

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

Shouldn't AZFW0017 #3359 also be documented? (even the same author)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Oh good catch I looked at both independently, I will create a follow up pr tomorrow to adjust this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

it is covered here #3370 thanks @Frulfump for noticing this!

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.

Microsoft.Azure.Functions.Worker.Sdk missing package README

3 participants