Repository navigation
Write every README note as a GitHub alert - #146
Merged
paolosalvatori merged 1 commit intoOct 27, 2026
Merged
paolosalvatori merged 1 commit into
paolosalvatori merged 1 commit into
Conversation
The READMEs wrote their callouts five ways: GitHub alerts (> [!NOTE]), a bold marker on its own line (> **Note**), an inline bold marker (> **Note:** text), a plain **Note:** paragraph, and one blockquote with no marker. Every callout is now a GitHub alert, with the type that matches what it says: - IMPORTANT: the Mac notes, the SQL Server EULA notes, and the note that the Event Hubs and Event Grid sample needs cdn.functions.azure.com to resolve. - TIP: the lstk az hints, the Azure CLI --verbose and --debug hint, and the storage account key hint. - CAUTION: pinning an emulator image older than localstack-pro#8102 breaks every Function App deployment on arm64. - NOTE: the first-deployment timing notes, the AKS samples pointer, the Terraform differences, the Java app running on the host, and the commented-out Service Bus function. The text stays as it was, except the Core Tools note of function-app-storage-http, which named 4.2.2 and AZURE_FUNCTIONS_CORE_TOOLS_VERSION: the emulator's default is 4.15.1 (4.13.0 on arm64), set through LS_AZURE_FUNCTIONS_CORE_TOOLS_VERSION. Fixes SMF-992 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NGfV8ZhpdZCZfbmfwWd3Sw
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The revised Core Tools defaults and override variable still need confirmation against the emulator implementation, which was unavailable during review.
No open issues 🎉
What changed in this PR
This documentation-only PR standardizes callouts across the Azure samples using GitHub alerts, making deployment requirements, warnings, and optional guidance easier to distinguish.
Changes:
- Converts existing callouts to consistent GitHub alert syntax.
- Assigns alert types by purpose, including
IMPORTANTfor the Mac prerequisites introduced in #145. - Updates the documented Azure Functions Core Tools defaults and environment-variable override.
| File | Description |
|---|---|
| samples/web-app-sql-database/python/terraform/README.md | Marks SQL Server EULA acceptance as important. |
| samples/web-app-sql-database/python/scripts/README.md | Marks SQL Server EULA acceptance as important. |
| samples/web-app-sql-database/python/README.md | Standardizes Mac, EULA, and deployment callouts. |
| samples/web-app-sql-database/python/bicep/README.md | Marks SQL Server EULA acceptance as important. |
| samples/web-app-sql-database/dotnet/terraform/README.md | Marks SQL Server EULA acceptance as important. |
| samples/web-app-sql-database/dotnet/scripts/README.md | Marks SQL Server EULA acceptance as important. |
| samples/web-app-sql-database/dotnet/README.md | Standardizes Mac, EULA, and deployment callouts. |
| samples/web-app-sql-database/dotnet/bicep/README.md | Marks SQL Server EULA acceptance as important. |
| samples/web-app-postgresql-flexible-server/python/README.md | Standardizes Mac and deployment callouts. |
| samples/web-app-postgresql-flexible-server/dotnet/README.md | Standardizes Mac and deployment callouts. |
| samples/web-app-mysql-flexible-server/python/README.md | Standardizes Mac and deployment callouts. |
| samples/web-app-mysql-flexible-server/dotnet/README.md | Standardizes Mac and deployment callouts. |
| samples/web-app-managed-identity/python/scripts/README.md | Classifies CLI interception guidance as a tip. |
| samples/web-app-managed-identity/python/README.md | Standardizes prerequisites, timing notes, and storage tips. |
| samples/web-app-managed-identity/dotnet/scripts/README.md | Classifies CLI interception guidance as a tip. |
| samples/web-app-managed-identity/dotnet/README.md | Standardizes prerequisites, timing notes, and storage tips. |
| samples/web-app-custom-image/python/terraform/README.md | Converts the Terraform limitation callout to an alert. |
| samples/web-app-custom-image/python/README.md | Converts the initial-deployment note to an alert. |
| samples/web-app-custom-image/dotnet/terraform/README.md | Converts the Terraform limitation callout to an alert. |
| samples/web-app-custom-image/dotnet/README.md | Converts the initial-deployment note to an alert. |
| samples/web-app-cosmosdb-nosql-api/python/README.md | Standardizes Mac and deployment callouts. |
| samples/web-app-cosmosdb-nosql-api/dotnet/README.md | Standardizes Mac and deployment callouts. |
| samples/web-app-cosmosdb-mongodb-api/python/README.md | Standardizes Mac and deployment callouts. |
| samples/web-app-cosmosdb-mongodb-api/dotnet/README.md | Standardizes Mac and deployment callouts. |
| samples/web-app-app-configuration/python/README.md | Standardizes Mac and deployment callouts. |
| samples/web-app-app-configuration/dotnet/README.md | Standardizes Mac and deployment callouts. |
| samples/url-shortener/python/README.md | Marks Mac prerequisites as important. |
| samples/servicebus/java/README.md | Converts host-runtime and deployment notes to alerts. |
| samples/function-app-storage-http/dotnet/README.md | Standardizes alerts and updates Core Tools configuration guidance. |
| samples/function-app-storage-http/dotnet/METHODS.md | Converts the disabled-function note to an alert. |
| samples/function-app-service-bus/dotnet/README.md | Standardizes Mac and deployment callouts. |
| samples/function-app-managed-identity/python/terraform/README.md | Converts CLI interception guidance to a tip. |
| samples/function-app-managed-identity/python/scripts/README.md | Classifies CLI interception guidance as a tip. |
| samples/function-app-managed-identity/python/README.md | Standardizes prerequisites, timing notes, and storage tips. |
| samples/function-app-managed-identity/python/bicep/README.md | Converts CLI interception and debugging guidance to tips. |
| samples/function-app-front-door/python/README.md | Marks Mac prerequisites as important. |
| samples/eventhubs/python/README.md | Standardizes Mac and deployment callouts. |
| samples/eventhubs-eventgrid/python/README.md | Marks DNS and Mac prerequisites as important. |
| samples/api-management-function-app/python/README.md | Marks Mac prerequisites as important. |
| samples/aci-blob-storage/python/terraform/README.md | Converts the Key Vault limitation note to an alert. |
| README.md | Highlights Mac requirements and older-image deployment risks. |
Review effort: Balanced
Contributor
Author
|
Copilot's review summary asked for the revised Core Tools default and override variable to be confirmed against the emulator. Confirmed: Function Apps on the emulator run Azure Functions Core Tools 4.15.1 by default, and 4.13.0 on an arm64 host, and |
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The READMEs wrote their callouts in five different ways:
> [!NOTE]).> **Note**, often with two trailing spaces).> **Note:** text).**Note:** textparagraph (function-app-storage-http/dotnet/METHODS.md).eventhubs-eventgrid/python/README.md).The type did not follow the content either. The Mac notes from #145 were
NOTEalthough a Mac user needs them to deploy at all, and thelstk azhints wereNOTEin some READMEs and plain bold notes in others.Changes
Every callout is now a GitHub alert, with the type that matches what it says:
IMPORTANT: key to reaching the goalcdn.functions.azure.comto resolveTIP: makes things easierlstk azhints (5), the Azure CLI--verboseand--debughint, and the storage account key hint (4)CAUTION: risk of an actionNOTE: useful to knowThe text of every callout stays as it was, with one exception: the Core Tools note in
function-app-storage-http/dotnet/README.mdsaid the default version is 4.2.2 and the variable isAZURE_FUNCTIONS_CORE_TOOLS_VERSION. The emulator's default is 4.15.1 (4.13.0 on an arm64 host), and the variable isLS_AZURE_FUNCTIONS_CORE_TOOLS_VERSION(the Configuration table of the Function Apps docs page).Tests
IMPORTANT, 28NOTE, 10TIP, 1CAUTION), and no**Note**,**Note:**or marker-less callout is left.caution,importantandnotealerts, andfunction-app-managed-identity/python/README.mdwithimportant,noteandtipalerts: one per marker.Related
🤖 Generated with Claude Code
https://claude.ai/code/session_01NGfV8ZhpdZCZfbmfwWd3Sw