Skip to content

Add publish command and manifest template management#18

Merged
sellakumaran merged 2 commits into
mainfrom
users/sellak/publish
Nov 15, 2025
Merged

Add publish command and manifest template management#18
sellakumaran merged 2 commits into
mainfrom
users/sellak/publish

Conversation

@sellakumaran
Copy link
Copy Markdown
Contributor

Introduced a new publish command to streamline packaging and publishing of agent manifests to the MOS Titles service. Key features include embedded templates, automatic ID updates, interactive customization, and Graph API integration.

Added ManifestTemplateService for managing embedded manifest templates, enabling extraction, customization, and packaging of manifest files. Updated dependency injection to include this service.

Enhanced error handling in PublishCommand to manage network issues, timeouts, and authorization errors, with fallback instructions for manual uploads.

Updated manifest.json and agenticUserTemplateManifest.json schemas with detailed metadata and new fields. Embedded templates and icons as resources in the CLI binary for portability.

Refactored PublishCommand for improved modularity and logging. Added comprehensive unit tests for the new ManifestTemplateService. Updated documentation with detailed instructions for the publish command.

Introduced a new `publish` command to streamline packaging
and publishing of agent manifests to the MOS Titles service.
Key features include embedded templates, automatic ID updates,
interactive customization, and Graph API integration.

Added `ManifestTemplateService` for managing embedded
manifest templates, enabling extraction, customization, and
packaging of manifest files. Updated dependency injection
to include this service.

Enhanced error handling in `PublishCommand` to manage
network issues, timeouts, and authorization errors, with
fallback instructions for manual uploads.

Updated `manifest.json` and `agenticUserTemplateManifest.json`
schemas with detailed metadata and new fields. Embedded
templates and icons as resources in the CLI binary for
portability.

Refactored `PublishCommand` for improved modularity and
logging. Added comprehensive unit tests for the new
`ManifestTemplateService`. Updated documentation with
detailed instructions for the `publish` command.
@sellakumaran sellakumaran requested a review from a team as a code owner November 15, 2025 03:07
Copilot AI review requested due to automatic review settings November 15, 2025 03:07
@sellakumaran sellakumaran requested a review from a team as a code owner November 15, 2025 03:07
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

This PR introduces a comprehensive publish command feature that enables streamlined packaging and publishing of agent manifests to the MOS Titles service. The implementation focuses on portability by embedding all required templates (JSON and PNG files) directly in the CLI binary, eliminating external file dependencies.

Key changes include:

  • Added ManifestTemplateService for managing embedded manifest templates with methods for extraction, customization, and packaging
  • Enhanced PublishCommand with automatic template extraction, improved error handling for network issues, and graceful degradation for authorization failures
  • Comprehensive test suite with 30+ unit tests covering all service methods and edge cases

Reviewed Changes

Copilot reviewed 10 out of 12 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
src/Tests/Microsoft.Agents.A365.DevTools.Cli.Tests/Services/ManifestTemplateServiceTests.cs Comprehensive unit test suite covering template extraction, manifest updates, validation, and zip creation
src/Microsoft.Agents.A365.DevTools.Cli/Templates/outline.png Embedded outline icon template (32x32 PNG)
src/Microsoft.Agents.A365.DevTools.Cli/Templates/manifest.json Embedded Teams app manifest template with agent metadata
src/Microsoft.Agents.A365.DevTools.Cli/Templates/color.png Embedded color icon template (192x192 PNG)
src/Microsoft.Agents.A365.DevTools.Cli/Templates/agenticUserTemplateManifest.json Embedded agent identity blueprint configuration template
src/Microsoft.Agents.A365.DevTools.Cli/Services/ManifestTemplateService.cs Core service implementing template extraction, manifest ID updates, validation, and zip packaging
src/Microsoft.Agents.A365.DevTools.Cli/Program.cs Updated dependency injection to register ManifestTemplateService and wire it into PublishCommand
src/Microsoft.Agents.A365.DevTools.Cli/Microsoft.Agents.A365.DevTools.Cli.csproj Added EmbeddedResource entries for manifest templates and icon files
src/Microsoft.Agents.A365.DevTools.Cli/Commands/PublishCommand.cs Enhanced with template extraction logic, improved network error handling, and timeout management
src/DEVELOPER.md Added comprehensive publish command documentation with workflow examples and troubleshooting guide
manifest/manifest.json Removed project-level manifest file (migrated to embedded templates)
manifest/addendum.json Removed unused addendum file

Comment thread src/Microsoft.Agents.A365.DevTools.Cli/Templates/manifest.json Outdated
Comment thread src/Microsoft.Agents.A365.DevTools.Cli/Commands/PublishCommand.cs Outdated
Comment thread src/Microsoft.Agents.A365.DevTools.Cli/Commands/PublishCommand.cs Outdated
Refactored `PublishCommand` to use `using` statements for
`StringContent` objects, ensuring proper disposal and better
resource management.

Updated `manifest.json` to revise the agent's name and
description:
- Changed `name.short` to "Your Agent Name" and `name.full`
  to "Your Agent Full Name."
- Replaced `description.short` and `description.full` with
  more generic and comprehensive descriptions of the agent's
  purpose and capabilities.
@sellakumaran sellakumaran merged commit cf2ab7f into main Nov 15, 2025
2 checks passed
@sellakumaran sellakumaran deleted the users/sellak/publish branch November 15, 2025 05:22
sellakumaran added a commit that referenced this pull request Feb 27, 2026
* Add `publish` command and manifest template management

Introduced a new `publish` command to streamline packaging
and publishing of agent manifests to the MOS Titles service.
Key features include embedded templates, automatic ID updates,
interactive customization, and Graph API integration.

Added `ManifestTemplateService` for managing embedded
manifest templates, enabling extraction, customization, and
packaging of manifest files. Updated dependency injection
to include this service.

Enhanced error handling in `PublishCommand` to manage
network issues, timeouts, and authorization errors, with
fallback instructions for manual uploads.

Updated `manifest.json` and `agenticUserTemplateManifest.json`
schemas with detailed metadata and new fields. Embedded
templates and icons as resources in the CLI binary for
portability.

Refactored `PublishCommand` for improved modularity and
logging. Added comprehensive unit tests for the new
`ManifestTemplateService`. Updated documentation with
detailed instructions for the `publish` command.

* Improve resource management and update agent metadata

Refactored `PublishCommand` to use `using` statements for
`StringContent` objects, ensuring proper disposal and better
resource management.

Updated `manifest.json` to revise the agent's name and
description:
- Changed `name.short` to "Your Agent Name" and `name.full`
  to "Your Agent Full Name."
- Replaced `description.short` and `description.full` with
  more generic and comprehensive descriptions of the agent's
  purpose and capabilities.
sellakumaran added a commit that referenced this pull request Mar 8, 2026
…aph, tests)

Exit codes (#7, #8/#9):
- Set Environment.ExitCode = 1 in ValidateDeploymentPrerequisitesAsync before
  each null return so callers exit non-zero on config/Web App validation failure
- Replace deploy-mcp guard `return` with ExceptionHandler.ExitWithCleanup(1)
  for AgentBlueprintId, AgenticAppId, and TenantId missing-config cases

Log severity (#15, #16, #17):
- LogCheckWarning: LogInformation -> LogWarning
- LogCheckFailure: all three LogInformation -> LogError
- ExecuteCheckWithLoggingAsync warning path: log ErrorMessage ?? Details
  so the primary warning message is no longer silently dropped

skip-graph regressions (#21, #22):
- Guard RunChecksOrExitAsync(MOS checks) behind if (!skipGraph)
- Guard clientAppId null check behind !skipGraph in PublishCommand

Unused parameter (#14):
- Remove IPrerequisiteRunner from BlueprintSubcommand.CreateCommand signature
- Update SetupCommand.cs call site and BlueprintSubcommandTests accordingly

InfrastructureRequirementCheck (#5, #6):
- Add I1/I2/I3/I1V2/I2V2/I3V2 (Isolated) SKUs to validation error message
- Wrap CheckAsync with ExecuteCheckWithLoggingAsync so [PASS]/[FAIL] is printed

PrerequisiteRunner warning message (#3):
- Log ErrorMessage ?? Details, log even when both are empty

IsCaeError gap (#18):
- Add InvalidAuthenticationToken to IsCaeError in ClientAppValidator

Stale comment (#10):
- Update ValidateDeploymentPrerequisitesAsync doc to remove "environment"

Tests (#19, #20):
- Add AppServiceAuthRequirementCheckTests (success, failure, metadata, null guard)
- Add MosPrerequisitesRequirementCheckTests (exception->failure, metadata, null guards)
- Update FrontierPreviewRequirementCheckTests: [WARN] now at LogWarning not LogInformation

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
sellakumaran added a commit that referenced this pull request Mar 10, 2026
…siteRunner (#106) (#312)

* feat: unify prerequisite validation via IRequirementCheck + IPrerequisiteRunner (#106)

Commands now declare prerequisites using IRequirementCheck and fail early
with actionable messages before any side effects occur.

Phase 1 - pure reorganization (zero behavioral change):
- Add AzureAuthRequirementCheck and InfrastructureRequirementCheck adapters
- Add IPrerequisiteRunner / PrerequisiteRunner to run checks in order
- Route AllSubcommand, BlueprintSubcommand, InfrastructureSubcommand,
  and DeployCommand through the shared runner instead of ad-hoc validators
- Delete dead code: ISubCommand.ValidateAsync, IAzureValidator/AzureValidator
- Make AzureAuthValidator.ValidateAuthenticationAsync virtual for testability

Phase 2 - minimal early-fail additions:
- cleanup azure: auth check before preview display
- deploy mcp: explicit early guards for agentBlueprintId and agenticAppId
  before any Graph/network calls

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: three CLI polish fixes

- ConfigFileNotFoundException now extends Agent365Exception so missing
  config errors surface as clean user messages (no stack trace) on all
  commands, not just those with local catch blocks. Removes ad-hoc
  FileNotFoundException catches in CleanupCommand and CreateInstanceCommand.

- config init: expand relative/dot deployment paths to absolute before
  saving so the stored value is portable across directories. Update help
  text to clarify relative paths are accepted.

- config init: drop platform-specific parenthetical from 'Allow public
  client flows' log message -- the setting is required on all platforms.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Polish CLI output: reduce noise, fix ordering, add TraceId

- Move "Running all setup steps..." to after requirements check output
- Remove redundant "Agent 365 Setup" header (user already knows the command)
- Change CorrelationId log to LogDebug for setup all and blueprint; surface
  as TraceId inline on the action line ("Running all setup steps... (TraceId: ...)")
  so it is always captured in setup.log as [INF] and visible on console
- Demote PlatformDetector internal logs to LogDebug; single "Detected project
  platform: X" line remains as the user-facing output
- Add AzureAuthRequirementCheck to GetConfigRequirementChecks so Azure auth
  appears in requirements output for all setup subcommands
- Remove redundant mid-execution auth gate from BlueprintSubcommand that caused
  duplicate [PASS] Azure Authentication output
- Fix RequirementCheck base class: use LogInformation for all check result lines
  to avoid WARNING:/ERROR: prefix doubling from logger formatter
- Collapse verbose requirements summary to single line:
  "Requirements: X passed, Y warnings, Z failed"
- Update tests to match new message text and log level assertions

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat: add fail-early requirement checks to remaining commands

Extends fail-early validation to setup infrastructure, setup permissions,
setup copilot-studio, cleanup azure, deploy, and publish commands.
Each command now runs targeted IRequirementCheck-based pre-flight checks
with formatted [PASS]/[FAIL] output before executing destructive or
slow operations, surfacing auth and config failures immediately.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* refactor: structured requirement check composition + fix CAE token revocation UX

Phase 1 (zero behavioral change):
- Add GetBaseChecks() to SetupCommand and CleanupCommand for explicit check composition
- Add GetChecks() to each setup subcommand so check lists are co-located with their command
- Add RunChecksOrExitAsync() helper to RequirementsSubcommand to eliminate four-line boilerplate
- Guard all requirement check calls with if (!dryRun) to avoid spurious network calls
- Update RequirementsSubcommandTests to use public API after making internal helpers private

Fix CAE token revocation UX:
- Add ClientAppValidationException.TokenRevoked() factory for clear re-auth guidance
- Detect server-side CAE token revocation in GetClientAppInfoAsync and throw TokenRevoked
  instead of returning null (which was misreported as "app not found")
- Pass suppressErrorLogging: true to all az CLI calls in ClientAppValidator so raw error
  output no longer leaks to console before the formatted [FAIL] message
- Update ClientAppValidatorTests mocks to match suppressErrorLogging parameter

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: suppress raw subprocess output leaking before structured check results

AzureAuthValidator: add suppressErrorLogging to az account show call to
prevent CommandExecutor from printing raw stderr before [FAIL] output.
Remove verbose LogError/LogInformation guidance blocks — the validator
returns bool only; issue/resolution messaging belongs in the check layer.

PowerShellModulesRequirementCheck: downgrade auto-install progress from
LogInformation/LogWarning to LogDebug so they don't print before [PASS].

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat: add cleanup azure --dry-run, AppService/MOS checks, update docs

- Add `--dry-run` flag to `a365 cleanup azure`: previews resources that
  would be deleted without requiring Azure auth or making any changes
- Add `AppServiceAuthRequirementCheck`: validates App Service deployment
  token before `a365 deploy`, catching AADSTS50173 token revocation early
- Add `MosPrerequisitesRequirementCheck`: validates MOS service principals
  before `a365 publish` proceeds, converting SetupValidationException to
  structured failure output
- Wire new checks into DeployCommand and PublishCommand via
  RunChecksOrExitAsync, replacing ad-hoc inline validation
- Add `GetChecks(AzureAuthValidator)` to InfrastructureSubcommand for
  explicit check composition
- Add `GetAppServiceTokenAsync` to AzureAuthValidator
- Update CLI design.md: add Requirements/ to project structure and
  document the IRequirementCheck prerequisite validation pattern
- Update CHANGELOG.md with user-visible additions

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* fix: address PR #312 review comments (exit codes, log levels, skip-graph, tests)

Exit codes (#7, #8/#9):
- Set Environment.ExitCode = 1 in ValidateDeploymentPrerequisitesAsync before
  each null return so callers exit non-zero on config/Web App validation failure
- Replace deploy-mcp guard `return` with ExceptionHandler.ExitWithCleanup(1)
  for AgentBlueprintId, AgenticAppId, and TenantId missing-config cases

Log severity (#15, #16, #17):
- LogCheckWarning: LogInformation -> LogWarning
- LogCheckFailure: all three LogInformation -> LogError
- ExecuteCheckWithLoggingAsync warning path: log ErrorMessage ?? Details
  so the primary warning message is no longer silently dropped

skip-graph regressions (#21, #22):
- Guard RunChecksOrExitAsync(MOS checks) behind if (!skipGraph)
- Guard clientAppId null check behind !skipGraph in PublishCommand

Unused parameter (#14):
- Remove IPrerequisiteRunner from BlueprintSubcommand.CreateCommand signature
- Update SetupCommand.cs call site and BlueprintSubcommandTests accordingly

InfrastructureRequirementCheck (#5, #6):
- Add I1/I2/I3/I1V2/I2V2/I3V2 (Isolated) SKUs to validation error message
- Wrap CheckAsync with ExecuteCheckWithLoggingAsync so [PASS]/[FAIL] is printed

PrerequisiteRunner warning message (#3):
- Log ErrorMessage ?? Details, log even when both are empty

IsCaeError gap (#18):
- Add InvalidAuthenticationToken to IsCaeError in ClientAppValidator

Stale comment (#10):
- Update ValidateDeploymentPrerequisitesAsync doc to remove "environment"

Tests (#19, #20):
- Add AppServiceAuthRequirementCheckTests (success, failure, metadata, null guard)
- Add MosPrerequisitesRequirementCheckTests (exception->failure, metadata, null guards)
- Update FrontierPreviewRequirementCheckTests: [WARN] now at LogWarning not LogInformation

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

6 participants