Skip to content

feat: add Windows installer and improve skill discoverability#274

Merged
andreszorro merged 9 commits into
mainfrom
feature/skills-discoverability
May 25, 2026
Merged

feat: add Windows installer and improve skill discoverability#274
andreszorro merged 9 commits into
mainfrom
feature/skills-discoverability

Conversation

@andreszorro
Copy link
Copy Markdown
Collaborator

@andreszorro andreszorro commented May 25, 2026

Summary

Adds a Windows installation pipeline for scfz (mirroring the existing macOS/Linux install.sh approach) and reorganizes the Scaffoldizr skill assets for better agent discoverability.

Changes

Windows installer

  • Added pkg/standalone/install.ps1.envsubst — PowerShell install script template with ${SCFZ_VERSION} substitution
  • Added scripts/render-install-ps1.sh — renders the template at release time (mirrors render-install.sh)
  • Updated scripts/release.sh to render and output install.ps1 alongside install.sh
  • Updated .github/workflows/release.yaml to copy install.ps1 to docs/assets/ and commit it on each release
  • Added initial docs/assets/install.ps1 for v0.13.0

Documentation

  • Updated README.md and architecture/docs/02-getting-started.md with platform-specific install sections (macOS/Linux via curl, Windows via irm | iex)
  • Updated .agents/skills/scaffoldizr/SKILL.md with the same Windows install instructions for AI agents

Skill discoverability

  • Moved skill files from .claude/skills/scaffoldizr/ to .agents/skills/scaffoldizr/
  • Updated internal references in documentation files to reflect new paths
  • Improved frontmatter metadata in SKILL.md for better agent discoverability

@upwind-code-us
Copy link
Copy Markdown

Upwind Upwind Code Scan - ⚠️ Deploy with Caution

1 newly introduced vulnerabilities · 0 resolved · 1 total in this PR vs main

🟡 1 Medium


🟡 Medium · 1 finding
CVE Package Version Fix
CVE-2026-33637 faraday 2.14.1 2.14.2

View full analysis in Upwind Console

Scan completed in 12s

@upwind-code-us
Copy link
Copy Markdown

Upwind Upwind IaC Scan - ✅ Proceed with Deployment

0 misconfigurations detected

View full analysis in Upwind Console →

Scan completed in 27s

@andreszorro andreszorro force-pushed the feature/skills-discoverability branch from e7041ba to a46194d Compare May 25, 2026 21:07
@upwind-code-us
Copy link
Copy Markdown

Upwind Upwind Code Scan - ⚠️ Deploy with Caution

1 newly introduced vulnerabilities · 0 resolved · 1 total in this PR vs main

🟡 1 Medium


🟡 Medium · 1 finding
CVE Package Version Fix
CVE-2026-33637 faraday 2.14.1 2.14.2

View full analysis in Upwind Console

Scan completed in 16s

@upwind-code-us
Copy link
Copy Markdown

Upwind Upwind IaC Scan - ✅ Proceed with Deployment

0 misconfigurations detected

View full analysis in Upwind Console →

Scan completed in 15s

@andreszorro andreszorro changed the title refactor: improved frontmatter for skill discoverability feat: add Windows installer and improve skill discoverability May 25, 2026
@andreszorro andreszorro requested a review from Copilot May 25, 2026 21:25
@andreszorro andreszorro force-pushed the feature/skills-discoverability branch from a46194d to a319686 Compare May 25, 2026 21:26
@upwind-code-us
Copy link
Copy Markdown

Upwind Upwind IaC Scan - ✅ Proceed with Deployment

0 misconfigurations detected

View full analysis in Upwind Console →

Scan completed in 2s

@upwind-code-us
Copy link
Copy Markdown

Upwind Upwind Code Scan - ✅ Proceed with Deployment

0 newly introduced vulnerabilities · 0 resolved · 0 total in this PR vs main

View full analysis in Upwind Console

Scan completed in 18s

Copy link
Copy Markdown

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

This PR aims to improve agent discoverability for Scaffoldizr by publishing a richer agent skill under .agents/skills/scaffoldizr/ with expanded reference docs and example assets (DSL snippets), aligning the skill content around “references” and “assets” folders.

Changes:

  • Expanded .agents/skills/scaffoldizr/SKILL.md frontmatter metadata and updated internal doc links to point to ./references/*.
  • Added/updated reference documentation to point to ../assets/* example folders.
  • Added a large set of example “asset” DSL snippets (views, systems, containers, components, relationships, archetypes) plus extra docs (CLI, TAGS) and a bundled LICENSE.

Reviewed changes

Copilot reviewed 15 out of 38 changed files in this pull request and generated no comments.

Show a summary per file
File Description
.agents/skills/scaffoldizr/SKILL.md Updates skill frontmatter and points element docs to the new references/ structure.
.agents/skills/scaffoldizr/references/view.md Updates example links from examples/ to assets/.
.agents/skills/scaffoldizr/references/softwareSystem.md Updates example links from examples/ to assets/.
.agents/skills/scaffoldizr/references/relationship.md Updates example links from examples/ to assets/.
.agents/skills/scaffoldizr/references/person.md Updates example links from examples/ to assets/.
.agents/skills/scaffoldizr/references/externalSystem.md Adds documentation for creating external systems and CLI usage.
.agents/skills/scaffoldizr/references/container.md Updates example links from examples/ to assets/.
.agents/skills/scaffoldizr/references/constant.md Adds documentation for defining Structurizr DSL constants and CLI usage.
.agents/skills/scaffoldizr/references/component.md Updates example links from examples/ to assets/.
.agents/skills/scaffoldizr/references/archetype.md Updates example links from examples/ to assets/.
.agents/skills/scaffoldizr/LICENSE Adds an MIT license file for the skill bundle.
.agents/skills/scaffoldizr/extra/TAGS.md Adds a tag reference guide for shape/status tags.
.agents/skills/scaffoldizr/extra/CLI.md Adds Structurizr CLI (Docker) troubleshooting/validation guidance.
.agents/skills/scaffoldizr/assets/views/system-landscape.dsl Adds a system landscape view example template.
.agents/skills/scaffoldizr/assets/views/system-context.dsl Adds a system context view example template.
.agents/skills/scaffoldizr/assets/views/dynamic.dsl Adds a dynamic view example template.
.agents/skills/scaffoldizr/assets/views/container.dsl Adds a container view example template.
.agents/skills/scaffoldizr/assets/views/component.dsl Adds a component view example template.
.agents/skills/scaffoldizr/assets/softwareSystems/test-system.dsl Adds an example software system DSL file.
.agents/skills/scaffoldizr/assets/softwareSystems/_system.dsl Adds an example _system.dsl file.
.agents/skills/scaffoldizr/assets/softwareSystems/_external.dsl Adds an example _external.dsl file.
.agents/skills/scaffoldizr/assets/relationships/_system.dsl Adds example relationships for system-scope relationships.
.agents/skills/scaffoldizr/assets/relationships/_people.dsl Adds example relationships involving people.
.agents/skills/scaffoldizr/assets/people/_people.dsl Adds example people definitions.
.agents/skills/scaffoldizr/assets/containers/test-system.dsl Adds an example container definition (NodeJS app).
.agents/skills/scaffoldizr/assets/containers/database.dsl Adds an example database container definition.
.agents/skills/scaffoldizr/assets/components/nodejs-app.dsl Adds example component definitions for a NodeJS app.
.agents/skills/scaffoldizr/assets/archetypes/4_componentExample_component.dsl Adds an example component archetype DSL snippet.
.agents/skills/scaffoldizr/assets/archetypes/3_softwareSystemExample_system.dsl Adds an example software system archetype DSL snippet.
.agents/skills/scaffoldizr/assets/archetypes/2_container_container.dsl Adds an example container archetype DSL snippet.
.agents/skills/scaffoldizr/assets/archetypes/1_http_relationship.dsl Adds an example relationship archetype for HTTPS.
Comments suppressed due to low confidence (3)

.agents/skills/scaffoldizr/SKILL.md:5

  • In the frontmatter, "Github" should be spelled "GitHub" (proper brand name) to keep documentation consistent and avoid broken search/recognition.
    .agents/skills/scaffoldizr/references/view.md:81
  • The link text says "examples of views", but the sentence ends with "examples of software system files". This looks like a copy/paste error and should refer to view files/examples instead to avoid confusing readers.
    .agents/skills/scaffoldizr/SKILL.md:6
  • PR description mentions adding a Windows installer (install.ps1(.envsubst)), a render script, and updating release workflow to publish install.ps1, but those files/updates are not present in this branch checkout (no install.ps1 under docs/assets/, no pkg/standalone/install.ps1.envsubst, no scripts/render-install-ps1.sh, and scripts/release.sh still only renders install.sh). Either the description needs updating or the missing Windows installer changes need to be included.

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

Copy link
Copy Markdown

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

Copilot reviewed 15 out of 38 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (1)

.agents/skills/scaffoldizr/SKILL.md:5

  • Use the correct brand capitalization: “GitHub” (not “Github”).

Comment thread scripts/render-install-ps1.sh
Comment thread .github/workflows/release.yaml
Comment on lines +26 to +30
New-Item -ItemType Directory -Force -Path $installDir | Out-Null
Remove-Item -Force -ErrorAction SilentlyContinue -Path $installPath

Invoke-WebRequest -Uri $downloadUrl -OutFile $installPath

@upwind-code-us
Copy link
Copy Markdown

Upwind Upwind IaC Scan - ✅ Proceed with Deployment

0 misconfigurations detected

View full analysis in Upwind Console →

Scan completed in 3s

@upwind-code-us
Copy link
Copy Markdown

Upwind Upwind Code Scan - ✅ Proceed with Deployment

0 newly introduced vulnerabilities · 0 resolved · 0 total in this PR vs main

View full analysis in Upwind Console

Scan completed in 43s

@andreszorro andreszorro merged commit e2ff7ae into main May 25, 2026
12 checks passed
@andreszorro andreszorro deleted the feature/skills-discoverability branch May 25, 2026 22:47
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.

2 participants