New template - talk to your data microhack - #935
New template - talk to your data microhack#935Henrik Motzkus (henrikmotzkus) wants to merge 11 commits into
Conversation
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
There was a problem hiding this comment.
Pull request overview
Adds a new gallery template entry for the “Microhack - Ask, Analyze, Act - Talk to Your Data in the Era of AI” scenario to the Awesome azd Docusaurus site, which is driven by website/static/templates.json.
Changes:
- Added a new template card entry (title/description/source/preview/tags) to
website/static/templates.json. - Introduced new tags/language/service metadata for the template.
| "preview": "./templates/images/Microhack-Talktoyourdata.png", | ||
| "authorUrl": "https://github.com/henrikmotzkus", | ||
| "author": "Henrik Motzkus", | ||
| "source": "https://github.com/henrikmotzkus/Microhack-TTYD", |
There was a problem hiding this comment.
Tong Xu (MSFT) (@v-xuto) Could you test this template?
There was a problem hiding this comment.
Marina He (@hemarina), Henrik Motzkus (@henrikmotzkus) We have finished this template test, and we filed two issues. Please review.
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
CI is red on this one. templates.json has a trailing comma in azureServices, which makes the whole file invalid JSON, so agent-templates.test.ts, tags_match.test.ts and gallery-filter.test.ts all fail to load.
I checked out the branch and ran the suite locally to confirm, then applied the changes suggested below and got 11/11 suites, 373/373 tests passing.
Blocking:
- Trailing comma after
"storag account"breaks JSON parsing "azure sql","storag account","t-sql"and"copilot"are not defined inwebsite/src/data/tags.tsx, sotags_match.test.tsfails as soon as the JSON parses
Worth fixing:
tagsis missingcommunity(ormsft) andnew. Both are in the PR checklist anddocs/contribute.md, and 363 of 394 existing entries carry one ofmsft/communityterraformsits inlanguages, but it is an IaC tag and you already have it correctly inIaCpowershellistype: "Tools"in tags.tsx, so it belongs intags. Same call came up on #916fabricis duplicated acrosstagsandazureServices. All four existing entries that use it put it only inazureServices
Nits:
- Zero-width space (U+200B) after "AI" in the title, plus five non-breaking hyphens (U+2011) in the description. Both look like copy/paste artifacts
- Description is 588 characters. The checklist asks for 1-2 sentences and most gallery entries land near 300
Two corrections to the automated review above, so you do not chase them: the tags array does have its comma after the closing ], and adding terraform to tags is not the convention here. The IaC field is what the gallery uses (10 entries vs 1).
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
The autofix in a465cf3 cleared the azureServices entries and templates.json parses again. CI is still red though, and it needs two more changes, not one.
I ran the suite against a465cf3 locally. tags_match.test.ts fails on copilot. That test calls expect(tagDefinition).toBeDefined() inside a forEach, so it stops at the first undefined tag and hides everything behind it. t-sql is queued right after. Dropping copilot on its own just buys you a second red run.
Removing copilot from tags and t-sql from languages takes that file to 4 passed and the suite to 373 passed.
The rest of my threads are still open: terraform sits in both languages and IaC, powershell belongs in tags rather than languages (same call was made on #916 and fixed there), fabric is in both tags and azureServices while the other four Fabric entries only use azureServices, community or msft plus new are still missing, and the title still carries the zero-width space after AI.
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
CI is green on 8fa28ac and the suite passes 11/11, so the parse failure and the undefined tag names are cleared. Three things left in the new entry.
fabric is in both tags and azureServices, and terraform is in both languages and IaC. The card flattens all five arrays into a single list and maps it straight to chips with no dedup, so this entry renders Microsoft Fabric and Terraform twice. It is the only one of 395 entries that produces a duplicate chip.
new is still missing from tags. Every entry added in the last four template PRs (#912, #913, #916, #918) carries it, and it is what drives the New badge on the card.
Smaller: the description is 586 characters against a gallery median of 185, and it still has five non-breaking hyphens in it.
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
One more on the metadata, and the three from my last pass are still open.
azure.yaml in the source repo declares host: appservice for the web service and infra/modules/app_service_linux provisions it, but appservice is missing from azureServices. Details inline.
Still open on 8fa28ac: fabric is in both tags and azureServices, terraform is in both languages and IaC, and the description is 586 characters with five non-breaking hyphens in it.
I applied all four locally on top of 8fa28ac. The entry lands on nine distinct chips with no duplicates, every tag resolves in tags.tsx, and the suite stays at 373/373.
Co-authored-by: Jon Gallant <2163001+jongio@users.noreply.github.com>
…/henrikmotzkus/awesome-azd into New-template---talk-to-your-data
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
Three commits landed since my last pass. The metadata items from that review are still open, and 23d92aad also introduced a whole-file reformat that I would undo before this merges.
templates.json went from 9,506 lines to 5,827. Most arrays got collapsed from multi-line to single-line, so the diff is now +1,420 -5,073 across 477 hunks for what is a one-entry addition. The committed style in this file is expanded arrays, 1,420 of them against 2 inline, so this flips the convention for all 394 existing entries.
It is only whitespace though. I parsed both sides and compared entry by entry: 1 added, 0 removed, 0 modified. Nothing was lost.
To put the formatting back:
node -e "const fs=require('fs');const p='website/static/templates.json';fs.writeFileSync(p,JSON.stringify(JSON.parse(fs.readFileSync(p,'utf8')),null,2)+'\n')"
That reproduces main byte for byte. Apply the three inline suggestions first, then run it, otherwise the line anchors shift. I did exactly that locally and the diff drops to 26 added lines in a single hunk with the suite at 373/373.
One more on 23d92aad: the message reads "Implement new feature for user authentication and improve error handling" on a commit that only touches templates.json.
Still open from my last pass, details inline: fabric is in both tags and azureServices so the card renders that chip twice, terraform is in both languages and IaC for the same reason, and new is missing from tags.
Co-authored-by: Jon Gallant <2163001+jongio@users.noreply.github.com>
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
Four things still open.
tags is missing new. The PR checklist lists it as required for newly authored templates, and 14 gallery entries carry it.
fabric is in both tags and azureServices, and terraform is in both languages and IaC. ShowcaseCard (src/components/gallery/ShowcaseCard/index.tsx:77-83) spreads all five arrays into one list, and ShowcaseCardTag maps every element to a chip with no dedup. So this entry renders two Fabric chips and two Terraform chips. It's the only one of 395 entries that produces duplicates.
terraform is also in the wrong bucket. It's type: "Infrastructure as Code" in tags.tsx, and the other 11 terraform templates list it under IaC only.
The whole-file reformat is the one worth fixing first. I added the details to the thread on line 10, including why the template-submission workflow will undo it.
Everything else from the last pass checks out. Tags all resolve, the description is down to 341 characters over two sentences, the invisible characters are gone, the preview image is in place, and I diffed all 394 existing entries against main to confirm the reformat didn't change any of them.
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
The template test came back while I was reviewing. Tong Xu (MSFT) (@v-xuto) filed two issues on the source repo and both are open:
- henrikmotzkus/Microhack-TTYD#2:
azd upfails.scripts/preprovision.ps1:80callsSet-AzContextwithTENANT_DOMAINand it errors both ways. A domain string is rejected because-Tenantwants a GUID, and the tenant ID form fails too. - henrikmotzkus/Microhack-TTYD#1: the README says
cd TTYD-TFafter clone, but the directory isMicrohack-TTYD.
The deploy failure is what blocks this now. Every gallery card hands the user azd init -t henrikmotzkus/Microhack-TTYD and azd up is the next step, so that path needs to work before the entry goes in.
The four items from my last pass are unchanged on e7f152b.
fabric is in tags (line 5809) and azureServices (5817). terraform is in languages (5813) and IaC (5823). ShowcaseCard (src/components/gallery/ShowcaseCard/index.tsx:77-82) spreads all five arrays into one list and ShowcaseTag maps it with no dedup, so the card renders two Fabric chips and two Terraform chips. Still the only one of 395 entries that does.
One detail I hadn't traced before: after the msft filter this entry has 9 chips, which takes the length <= number branch at ShowcaseTag/index.tsx:115-117. That branch keys on showcase_card_tag_${tagObject.tag}, so both Fabric chips get the same React key and both Terraform chips get the same one. That's a duplicate key warning and two duplicate DOM ids on top of the visual duplication.
terraform is in the wrong bucket independently of the duplication. It's type: "Infrastructure as Code" in tags.tsx. Of the 11 existing terraform templates, 10 put it in IaC and none put it in languages.
new is still missing from tags. It drives the star badge at ShowcaseCard/index.tsx:114, and update-templates-json.js:164 hardcodes it into every generated entry.
The whole-file reformat is still in: 9,481 lines down to 5,828, so +1,420 -5,073 for a one-entry addition.
I applied all four on top of e7f152b locally. Setting tags to ["ai","msft","new"] and languages to ["nodejs"], then normalizing the file:
node -e "const fs=require('fs');const p='website/static/templates.json';fs.writeFileSync(p,JSON.stringify(JSON.parse(fs.readFileSync(p,'utf8')),null,2)+'\n')"
takes the diff to 26 added lines in one hunk with the suite at 373/373. That command is what website/scripts/update-templates-json.js:189 already does, and .github/workflows/template-submission.yml:165 runs it on every submission, so the compacted format gets rewritten expanded the next time a template lands anyway.
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
tags is still missing new, and that's the only item left from my previous passes.
The PR checklist has it under required tags, website/scripts/update-templates-json.js:167 hardcodes ["msft", "new"] into every entry the submission workflow generates, and the seven most recent entries in the file all carry it. It drives the star badge at ShowcaseCard/index.tsx:125. Suggestion inline.
The rest is cleared on 2b84ba7. The reformat is reverted so the diff is one hunk at 25 added lines, the file matches canonical JSON.stringify(..., null, 2) output byte for byte, fabric and terraform are each in a single bucket so the card renders nine distinct chips, and all eight tags resolve in tags.tsx.
The two template test issues on the source repo are closed. henrikmotzkus/Microhack-TTYD@4f47b06 fixed the cd path in the README and the tenant handling in preprovision.ps1, so the azd up blocker I raised is no longer open.
I applied the new tag on top of 2b84ba7 locally and the suite stays at 373/373.
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
Verified on a3b51bc. new is in tags now, which was the last item open from my previous passes.
I ran the suite against the branch and got 11/11 suites, 373/373 tests. templates.json parses, all nine tags resolve in tags.tsx, and each one sits in the bucket the rest of the gallery uses. terraform is in IaC only and fabric is in azureServices only, so the card flattens to nine distinct chips with no duplicate React keys.
The file matches canonical JSON.stringify(..., null, 2) output byte for byte, so the whole-file reformat is fully reverted. The diff is one hunk at +26 -0 plus the preview image.
azureServices lines up with what the template actually deploys. appservice, fabric, azuresql and azurestorage each map to a module under infra/modules in the source repo, and azure.yaml declares host: appservice with provider: terraform.
Both template test issues Tong Xu (MSFT) (@v-xuto) filed are closed as of 4f47b06, so the azd up blocker is cleared. website/scripts/validate-template.js returns valid for the source repo, and CI is green.
Kristen Womack (kristenwomack)
left a comment
Kristen Womack (kristenwomack)
left a comment
There was a problem hiding this comment.
Thanks for submitting this, Henrik, and for the detail in the entry. The metadata is clean: the tags all resolve, the UUID is unique, and I confirmed the source repo is azd-compatible with a real azure.yaml and infra. Good shape.
A couple of things before I can approve:
- It's tagged
msft(Microsoft-authored), but the source lives in your personal account rather than under Azure-Samples. Our convention is that Microsoft-authored templates live in Azure-Samples. Would you be open to moving it there? If it's meant to be community-authored instead, we can switch the tag tocommunityand keep it where it is. - I didn't see a LICENSE file in the repo. For a Microsoft-authored sample we'll need one (MIT is standard). Could you add that?
Once we sort out the ownership and license, I will approve and merge. Really nice scenario, the Fabric plus SQL MI walkthrough is a great addition to the gallery.
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
Data on both of Kristen Womack (@kristenwomack)'s points, since they're what's blocking merge now.
msft is on 226 entries and 224 of them point at a Microsoft-controlled org (Azure-Samples, microsoft, Azure, dotnet, AzureCosmosDB). The one exception is seligj95/app-service-foundry-chat, added in #728 and merged by Marina He (@hemarina) in February. So the Azure-Samples convention holds at 224 of 226, with one merged precedent for an msft entry living in a personal repo.
The tag is defined by authorship rather than hosting. website/src/data/tags.tsx:172-175 labels it "Microsoft Authored" and describes it as "used for Microsoft azd templates", and website/docs/faq.md:84 splits the gallery into "Microsoft-authored azd-templates, and Community-contributed versions". Neither website/docs/contribute.md nor .github/PULL_REQUEST_TEMPLATE.md says anything about where the source repo has to live. So if this is Microsoft-authored work, msft is correct under the definitions in the repo today and the ask is a hosting policy question rather than a tag fix. The split is real on the other side though: 135 of 138 community entries sit in personal or third-party accounts.
The license is genuinely missing. repos/henrikmotzkus/Microhack-TTYD/license returns 404 and there's no LICENSE in the repo root. It isn't enforced today though. I sampled 19 msft template repos and 4 have no license at all, including Azure-Samples/azd-starter-bicep, Azure-Samples/pubsub-dapr-nodejs-servicebus, Azure-Samples/functions-quickstart-python-azd-sql and Azure-Samples/functions-quickstart-typescript-azd-eventhub.
If Azure-Samples hosting and a license are going to gate submissions, they belong in website/docs/contribute.md and the PR template. Right now a contributor has no way to know about either one before opening a PR.
My approval stands on the entry itself. On a3b51bc the suite is 11 of 11 suites and 373 of 373 tests, every tag resolves against tags.tsx, the UUID is unique, the image is present, and the two source repo issues Tong Xu (MSFT) (@v-xuto) filed are both closed. The ownership call is Kristen Womack (@kristenwomack)'s.
|
Henrik Motzkus (@henrikmotzkus) Regarding henrikmotzkus/Microhack-TTYD#2, I am still able to reproduce it. I have added relevant comments — please take a look and help clarify. |
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
Source now points at Azure-Samples/Microhack-Ask-Analyze-Act, which matches the msft tag. LICENSE is present on that repo. CI is green on this HEAD.
Re-approving after the source URL update.
Tong Xu (MSFT) (@v-xuto) the gallery entry now points at https://github.com/Azure-Samples/Microhack-Ask-Analyze-Act rather than the personal Microhack-TTYD repo. Worth retesting |
Marina He (hemarina)
left a comment
Marina He (hemarina)
left a comment
There was a problem hiding this comment.
Thank you for your contributions! Will merge the PR once testing issue is confirm resolved.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 2 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
website/static/templates.json:9491
- This entry is tagged as Microsoft-authored (
"msft"). Per the repo’s template submission guidelines for Microsoft templates, the PR author should provide proof the template deploys successfully (e.g., a pipeline run link or screenshots showingazd upsucceeds).
"tags": [
"ai",
"msft",
"new"
],
Jon Gallant (@jongio), Henrik Motzkus (@henrikmotzkus) The issue still exists. I have re-created it under the new repo Microhack-Ask-Analyze-Act. |
|
Tong Xu (MSFT) (@v-xuto) I traced Case 1 from your report and it's a defect in the source repo, not an environment problem on your side.
There's a second problem in the same block. The null guard is commented out: # if (-not [string]::IsNullOrWhiteSpace($Tenant)) {
# $setParams["Tenant"] = $Tenant
# }
Henrik Motzkus (@henrikmotzkus) two options: rename the variable to On Case 2, the script calls None of this changes the gallery entry in this PR. The tags, languages, |
Jon Gallant (jongio)
left a comment
Jon Gallant (jongio)
left a comment
There was a problem hiding this comment.
Two things since my approval on fc305fd.
The branch conflicts with main now. #940 landed the "Daily Repo Digest with AI Gateway" entry at the same spot in templates.json, so both PRs append at the end of the array and git can't auto-merge. mergeStateStatus is DIRTY as of right now.
It's a keep-both resolution, nothing subtle about it. I merged origin/main into fc305fd locally, kept both entries, and got 396 entries with the file still byte for byte identical to canonical JSON.stringify(..., null, 2) output. Suite came back 12 of 12 suites, 391 of 391 tests.
On the azd up testing that's gating merge, the failure Tong Xu (MSFT) (@v-xuto) hits at line 83 isn't the permission precheck.
preprovision.ps1 calls Get-AzureContextInfo at line 212, and that's what runs line 83. Test-GlobalAdministrator isn't called until line 221, Test-SubscriptionOwner until line 235. Line 83 fails before either permission check gets a chance to run, so the Global Administrator and Owner requirements are real but they aren't what produces that specific error.
The cause is what I traced last week and it's unchanged on the current tree:
$setParams = @{
Subscription = $SubscriptionId
ErrorAction = "Stop"
Tenant = $Tenant
}
# if (-not [string]::IsNullOrWhiteSpace($Tenant)) {
# $setParams["Tenant"] = $Tenant
# }
$context = Set-AzContext @setParamsLine 78 sets Tenant unconditionally, and the guard that would have made it conditional is commented out at lines 80 to 82. Line 42 reads TENANT_DOMAIN with -Optional, so an empty value is legitimate, but line 78 passes it to Set-AzContext either way. Restoring that guard and dropping Tenant out of the literal is the fix. That belongs in Azure-Samples/Microhack-Ask-Analyze-Act#5, not here.
The gallery entry itself is unchanged and still checks out on fc305fd. All nine tags resolve in tags.tsx, each one sits in a single bucket so the card renders nine distinct chips, the id and source are unique across the file, the image is in place, and the description is 341 characters. Source is under Azure-Samples with an MIT license, so both of Kristen Womack (@kristenwomack)'s items are closed out.
My approval stands. It just needs the branch updated before it can merge.
|
Henrik Motzkus (@henrikmotzkus) Could you share a screenshot for successful deployment during your testing Azure-Samples/Microhack-Ask-Analyze-Act#5 (comment)? |
Please fill out this template! There are three different types of contributions, feel free to delete the checklists that are not applicable to your contribution type.
If you are submitting a new
azdtemplate to the galleryFill this out if you want your template to be added to the awesome-azd gallery!
Your template repository
Place your template repository link here:
Added an entry to https://github.com/Azure/awesome-azd/blob/main/website/static/templates.json that includes:
Template title - A short title that reflects the local application stack that someone could use to get their application on Azure (e.g. "Containerized React Web App with Java API and MongoDB")
Description - 1-2 sentence description of the architecture (e.g. Azure services) or solution that is defined by the template.
Architecture Diagram or Application Screenshot - The image should include all services and their connections (example). You should add the image to the
website/static/templates/images.Link to Author's GitHub or other relevant website - Used for attribution
Author's Name - Name to credit on the gallery card
Link to template source - Link to the template GitHub repo
Tags - Specify tags to represent the template. If you don't see a relevant tag for your template? Feel free to add one!
Languages Tags - Tags for languages representing the template.
Azure Services Tags - Tags for azure services representing the template.
ID - Please provide a unique uuid.
Required tags:
"msft") or Community-authored ("community")"bicep"or"terraform")"new"tag for any newly authored templatesIn the PR comment, if you can also add a link to the PR where you made your repo
azdcompatible this will allow us to provide feedback on your template and speed up the review process.If the template is Microsoft-authored, we encourage you to also publish it to learn.microsoft.com/samples.
If you are submitting a resource to be added to the awesome-azd README: