Skip to content

[MSBUILD SDK] Add README.md to Azure.Functions.Sdk package#3373

Open
jviau wants to merge 2 commits intofeature/msbuild-sdkfrom
u/jviau/sdk-readme
Open

[MSBUILD SDK] Add README.md to Azure.Functions.Sdk package#3373
jviau wants to merge 2 commits intofeature/msbuild-sdkfrom
u/jviau/sdk-readme

Conversation

@jviau
Copy link
Copy Markdown
Contributor

@jviau jviau commented Apr 20, 2026

Issue describing the changes in this PR

resolves #issue_for_this_pr

Pull request checklist

  • My changes do not require documentation changes
    • Otherwise: Documentation issue linked to PR
  • My changes should not be added to the release notes for the next release
    • Otherwise: I've added my notes to release_notes.md
  • My changes do not need to be backported to a previous version
    • Otherwise: Backport tracked by issue/PR #issue_or_pr
  • I have added all required tests (Unit tests, E2E tests)

Additional information

  • Renames the existing README.md to README.DEV.md, as this readme is for dev reference
  • Adds a new README.md to be included with the nupkg
  • Fills our docs/sdk-rules/index.md

jviau and others added 2 commits April 20, 2026 09:49
@jviau
Add public README for Azure.Functions.Sdk NuGet package
36c9531 
- Create src/Azure.Functions.Sdk/README.md with SDK usage, minimal csproj
  example, migration guide from Microsoft.Azure.Functions.Worker.Sdk,
  azure_functions.g.csproj explanation, and link to SDK rules
- Fill out docs/sdk-rules/index.md with full AZFW0100-AZFW0109 rules table
- Wire README into NuGet package via PackageReadmeFile in csproj

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jviau
Tweak README.md
6fb73f1
Copilot AI review requested due to automatic review settings April 20, 2026 17:18
Copilot AI reviewed Apr 20, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds end-user documentation for the Azure.Functions.Sdk MSBuild SDK package so the NuGet package includes a proper README, while preserving the existing developer-focused README and expanding the SDK rules index page.

Changes:

  • Replaces src/Azure.Functions.Sdk/README.md with a consumer-oriented package README (usage + migration guidance).
  • Moves local development instructions into src/Azure.Functions.Sdk/README.DEV.md.
  • Updates packing metadata to include the README in the Azure.Functions.Sdk NuGet package, and expands docs/sdk-rules/index.md with the rule list.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
src/Azure.Functions.Sdk/README.md New package-facing README content (getting started, migration, rules links).
src/Azure.Functions.Sdk/README.DEV.md New dev-only README containing local development instructions previously in README.md.
src/Azure.Functions.Sdk/Azure.Functions.Sdk.csproj Sets PackageReadmeFile and attempts to pack README into the nupkg.
docs/sdk-rules/index.md Adds intro text and a table enumerating AZFW01xx SDK rules.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/Azure.Functions.Sdk/README.md
Comment on lines +88 to +92
You should **not** build, edit, or reference this project directly. If a traversal or `dirs.proj` file accidentally includes it, see [AZFW0109](https://github.com/Azure/azure-functions-dotnet-worker/blob/feature/msbuild-sdk/docs/sdk-rules/AZFW0109.md) for guidance.

## SDK Rules

The SDK emits diagnostics prefixed with `AZFW01xx`. See the full list of SDK rules [here](https://github.com/Azure/azure-functions-dotnet-worker/blob/feature/msbuild-sdk/docs/sdk-rules/index.md).
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

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

The README links hard-code the feature/msbuild-sdk branch in GitHub URLs. Once this is merged (or when consumed from a NuGet package), these links are likely to break or point at the wrong content. Use a stable target (e.g., blob/main/..., a tagged version, or a relative link that works on GitHub) for both the AZFW0109 and SDK rules index references.

Suggested change
You should **not** build, edit, or reference this project directly. If a traversal or `dirs.proj` file accidentally includes it, see [AZFW0109](https://github.com/Azure/azure-functions-dotnet-worker/blob/feature/msbuild-sdk/docs/sdk-rules/AZFW0109.md) for guidance.
## SDK Rules
The SDK emits diagnostics prefixed with `AZFW01xx`. See the full list of SDK rules [here](https://github.com/Azure/azure-functions-dotnet-worker/blob/feature/msbuild-sdk/docs/sdk-rules/index.md).
You should **not** build, edit, or reference this project directly. If a traversal or `dirs.proj` file accidentally includes it, see [AZFW0109](https://github.com/Azure/azure-functions-dotnet-worker/blob/main/docs/sdk-rules/AZFW0109.md) for guidance.
## SDK Rules
The SDK emits diagnostics prefixed with `AZFW01xx`. See the full list of SDK rules [here](https://github.com/Azure/azure-functions-dotnet-worker/blob/main/docs/sdk-rules/index.md).

Copilot uses AI. Check for mistakes.
Comment thread src/Azure.Functions.Sdk/Azure.Functions.Sdk.csproj
<None Include="Build/**" Pack="true" CamelCasePath="true" PackagePath="build/" />
<None Include="Sdk/**" Pack="true" CamelCasePath="true" PackagePath="sdk/" />
<None Include="Targets/**" Pack="true" CamelCasePath="true" PackagePath="targets/" />
<None Include="README.md" Pack="true" PackagePath="\" />
Copy link

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

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

PackageReadmeFile expects README.md at the package root, but this item uses PackagePath="\", which is inconsistent with the rest of the repo (other packages use PackagePath="/") and may result in the readme being packed under an unexpected path (breaking NuGet readme rendering). Pack the readme to the package root using the same PackagePath convention as the other packages.

Suggested change
<None Include="README.md" Pack="true" PackagePath="\" />
<None Include="README.md" Pack="true" PackagePath="/" />

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

area: sdk

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jviau