Pin microsoft/APM version to v0.8.0 and emit it in generated apm-action steps (#21297)

Author: Copilot

.github/workflows/cli-version-checker.lock.yml

@@ -1,5 +1,5 @@
 ---
-description: Monitors and updates agentic CLI tools (Claude Code, GitHub Copilot CLI, OpenAI Codex, GitHub MCP Server, Playwright MCP, Playwright Browser, MCP Gateway) for new versions
+description: Monitors and updates agentic CLI tools (Claude Code, GitHub Copilot CLI, OpenAI Codex, GitHub MCP Server, Playwright MCP, Playwright Browser, MCP Gateway, APM) for new versions
 on:
   schedule: daily
   workflow_dispatch:
@@ -31,7 +31,7 @@ timeout-minutes: 45
 
 # CLI Version Checker
 
-Monitor and update agentic CLI tools: Claude Code, GitHub Copilot CLI, OpenAI Codex, GitHub MCP Server, Playwright MCP, Playwright Browser, and MCP Gateway.
+Monitor and update agentic CLI tools: Claude Code, GitHub Copilot CLI, OpenAI Codex, GitHub MCP Server, Playwright MCP, Playwright Browser, MCP Gateway, and APM (Agent Package Manager).
 
 **Repository**: ${{ github.repository }} | **Run**: ${{ github.run_id }}
 
@@ -74,6 +74,11 @@ For each CLI/MCP server:
   - Release Notes: https://github.com/github/gh-aw-mcpg/releases
   - Docker Image: `ghcr.io/github/gh-aw-mcpg:v{VERSION}`
   - Used as default sandbox.agent container (see `pkg/constants/constants.go`)
+- **APM (Agent Package Manager)**: `https://api.github.com/repos/microsoft/APM/releases/latest`
+  - Repository: https://github.com/microsoft/APM
+  - Release Notes: https://github.com/microsoft/APM/releases
+  - Pinned via `DefaultAPMVersion` constant in `pkg/constants/constants.go`
+  - Used as the `version:` input in generated `microsoft/apm-action` steps
 
 **Optimization**: Fetch all versions in parallel using multiple npm view or WebFetch calls in a single turn.
 
@@ -119,6 +124,9 @@ For each update, analyze intermediate versions:
   - Parse release body for changelog entries
   - **CRITICAL**: Convert PR/issue references to full URLs (e.g., `https://github.com/github/gh-aw-mcpg/pull/123`)
   - Note: Used as default sandbox.agent container in MCP Gateway configuration
+- **APM**: Fetch release notes from https://github.com/microsoft/APM/releases/tag/{VERSION}
+  - Parse release body for changelog entries
+  - **CRITICAL**: Convert PR/issue references to full URLs (e.g., `https://github.com/microsoft/APM/pull/123`)
 
 **NPM Metadata Fallback**: When GitHub release notes are unavailable, use:
 - `npm view <package> --json` for package metadata
@@ -267,6 +275,7 @@ Legacy template reference (adapt to use Report Structure Pattern above):
   - GitHub MCP Server: Always fetch from https://github.com/github/github-mcp-server/releases
   - Playwright Browser: Always fetch from https://github.com/microsoft/playwright/releases
   - MCP Gateway: Always fetch from https://github.com/github/gh-aw-mcpg/releases
+  - APM: Always fetch from https://github.com/microsoft/APM/releases
   - Copilot CLI: Try to fetch, but may be inaccessible (private repo)
   - Playwright MCP: Check NPM metadata, uses Playwright versioning
 - **EXPLORE SUBCOMMANDS**: Install and test CLI tools to discover new features via `--help` and explore each subcommand

.github/workflows/cli-version-checker.md

@@ -86,6 +86,12 @@ async function main(core, ctx) {
     awInfo.cli_version = cliVersion;
   }
 
+  // Include apm_version only when APM dependencies are configured
+  const apmVersion = process.env.GH_AW_INFO_APM_VERSION;
+  if (apmVersion) {
+    awInfo.apm_version = apmVersion;
+  }
+
   // Write to /tmp/gh-aw directory to avoid inclusion in PR
   fs.mkdirSync(TMP_GH_AW_PATH, { recursive: true });
   const tmpPath = TMP_GH_AW_PATH + "/aw_info.json";

.github/workflows/smoke-claude.lock.yml

@@ -406,6 +406,9 @@ var SerenaLanguageSupport = map[string][]string{
 	},
 }
 
+// DefaultAPMVersion is the default version of the microsoft/APM (Agent Package Manager) CLI
+const DefaultAPMVersion Version = "v0.8.0"
+
 // DefaultPlaywrightMCPVersion is the default version of the @playwright/mcp package
 const DefaultPlaywrightMCPVersion Version = "0.0.68"
 

actions/setup/js/generate_aw_info.cjs

@@ -125,6 +125,7 @@ func GenerateAPMPackStep(apmDeps *APMDependenciesInfo, target string, data *Work
 		"          archive: 'true'",
 		"          target: "+target,
 		"          working-directory: /tmp/gh-aw/apm-workspace",
+		"          apm-version: ${{ env.GH_AW_INFO_APM_VERSION }}",
 	)
 
 	return GitHubActionStep(lines)
@@ -153,6 +154,7 @@ func GenerateAPMRestoreStep(apmDeps *APMDependenciesInfo, data *WorkflowData) Gi
 		"        uses: " + actionRef,
 		"        with:",
 		"          bundle: /tmp/gh-aw/apm-bundle/*.tar.gz",
+		"          apm-version: ${{ env.GH_AW_INFO_APM_VERSION }}",
 	}
 
 	if apmDeps.Isolated {

pkg/constants/constants.go

@@ -198,6 +198,40 @@ func TestExtractAPMDependenciesGitHubApp(t *testing.T) {
 	})
 }
 
+func TestExtractAPMDependenciesVersion(t *testing.T) {
+	t.Run("Object format with version field", func(t *testing.T) {
+		frontmatter := map[string]any{
+			"dependencies": map[string]any{
+				"packages": []any{"microsoft/apm-sample-package"},
+				"version":  "v1.0.0",
+			},
+		}
+		result := extractAPMDependenciesFromFrontmatter(frontmatter)
+		require.NotNil(t, result, "Should return non-nil APMDependenciesInfo")
+		assert.Equal(t, "v1.0.0", result.Version, "Version should be extracted from object format")
+	})
+
+	t.Run("Array format has no version field", func(t *testing.T) {
+		frontmatter := map[string]any{
+			"dependencies": []any{"microsoft/apm-sample-package"},
+		}
+		result := extractAPMDependenciesFromFrontmatter(frontmatter)
+		require.NotNil(t, result, "Should return non-nil APMDependenciesInfo")
+		assert.Empty(t, result.Version, "Version should be empty for array format")
+	})
+
+	t.Run("Object format without version uses empty string", func(t *testing.T) {
+		frontmatter := map[string]any{
+			"dependencies": map[string]any{
+				"packages": []any{"microsoft/apm-sample-package"},
+			},
+		}
+		result := extractAPMDependenciesFromFrontmatter(frontmatter)
+		require.NotNil(t, result, "Should return non-nil APMDependenciesInfo")
+		assert.Empty(t, result.Version, "Version should be empty when not specified")
+	})
+}
+
 func TestEngineGetAPMTarget(t *testing.T) {
 	tests := []struct {
 		name     string
@@ -253,6 +287,7 @@ func TestGenerateAPMPackStep(t *testing.T) {
 				"archive: 'true'",
 				"target: copilot",
 				"working-directory: /tmp/gh-aw/apm-workspace",
+				"apm-version: ${{ env.GH_AW_INFO_APM_VERSION }}",
 			},
 		},
 		{
@@ -266,6 +301,7 @@ func TestGenerateAPMPackStep(t *testing.T) {
 				"- microsoft/apm-sample-package",
 				"- github/skills/review",
 				"target: claude",
+				"apm-version: ${{ env.GH_AW_INFO_APM_VERSION }}",
 			},
 		},
 		{
@@ -274,6 +310,15 @@ func TestGenerateAPMPackStep(t *testing.T) {
 			target:  "all",
 			expectedContains: []string{
 				"target: all",
+				"apm-version: ${{ env.GH_AW_INFO_APM_VERSION }}",
+			},
+		},
+		{
+			name:    "Custom APM version still uses env var reference in step",
+			apmDeps: &APMDependenciesInfo{Packages: []string{"microsoft/apm-sample-package"}, Version: "v1.0.0"},
+			target:  "copilot",
+			expectedContains: []string{
+				"apm-version: ${{ env.GH_AW_INFO_APM_VERSION }}",
 			},
 		},
 	}
@@ -323,6 +368,7 @@ func TestGenerateAPMRestoreStep(t *testing.T) {
 				"Restore APM dependencies",
 				"microsoft/apm-action",
 				"bundle: /tmp/gh-aw/apm-bundle/*.tar.gz",
+				"apm-version: ${{ env.GH_AW_INFO_APM_VERSION }}",
 			},
 			expectedNotContains: []string{"isolated"},
 		},
@@ -334,6 +380,14 @@ func TestGenerateAPMRestoreStep(t *testing.T) {
 				"microsoft/apm-action",
 				"bundle: /tmp/gh-aw/apm-bundle/*.tar.gz",
 				"isolated: 'true'",
+				"apm-version: ${{ env.GH_AW_INFO_APM_VERSION }}",
+			},
+		},
+		{
+			name:    "Custom APM version still uses env var reference in step",
+			apmDeps: &APMDependenciesInfo{Packages: []string{"microsoft/apm-sample-package"}, Version: "v1.0.0"},
+			expectedContains: []string{
+				"apm-version: ${{ env.GH_AW_INFO_APM_VERSION }}",
 			},
 		},
 	}

pkg/workflow/apm_dependencies.go

@@ -382,3 +382,64 @@ func TestAllVersionsInAwInfo(t *testing.T) {
 		t.Errorf("Expected output to contain awmg_version '%s', got:\n%s", expectedAwmgLine, output)
 	}
 }
+
+func TestApmVersionInAwInfo(t *testing.T) {
+	tests := []struct {
+		name               string
+		apmDeps            *APMDependenciesInfo
+		expectedApmVersion string
+		description        string
+	}{
+		{
+			name:               "APM deps with explicit version",
+			apmDeps:            &APMDependenciesInfo{Packages: []string{"microsoft/apm-sample-package"}, Version: "v1.0.0"},
+			expectedApmVersion: "v1.0.0",
+			description:        "Should use explicit APM version when provided",
+		},
+		{
+			name:               "APM deps with default version",
+			apmDeps:            &APMDependenciesInfo{Packages: []string{"microsoft/apm-sample-package"}},
+			expectedApmVersion: string(constants.DefaultAPMVersion),
+			description:        "Should use default APM version when not specified",
+		},
+		{
+			name:               "No APM deps configured",
+			apmDeps:            nil,
+			expectedApmVersion: "",
+			description:        "Should not emit GH_AW_INFO_APM_VERSION when no APM dependencies are configured",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			compiler := NewCompilerWithVersion("1.0.0")
+			registry := GetGlobalEngineRegistry()
+			engine, err := registry.GetEngine("copilot")
+			if err != nil {
+				t.Fatalf("Failed to get copilot engine: %v", err)
+			}
+
+			workflowData := &WorkflowData{
+				Name:            "Test Workflow",
+				APMDependencies: tt.apmDeps,
+			}
+
+			var yaml strings.Builder
+			compiler.generateCreateAwInfo(&yaml, workflowData, engine)
+			output := yaml.String()
+
+			if tt.expectedApmVersion == "" {
+				if strings.Contains(output, "GH_AW_INFO_APM_VERSION") {
+					t.Errorf("%s: Expected output to NOT contain GH_AW_INFO_APM_VERSION, got:\n%s",
+						tt.description, output)
+				}
+			} else {
+				expectedLine := `GH_AW_INFO_APM_VERSION: "` + tt.expectedApmVersion + `"`
+				if !strings.Contains(output, expectedLine) {
+					t.Errorf("%s: Expected output to contain '%s', got:\n%s",
+						tt.description, expectedLine, output)
+				}
+			}
+		})
+	}
+}

pkg/workflow/apm_dependencies_test.go

@@ -511,13 +511,27 @@ func (c *Compiler) buildActivationJob(data *WorkflowData, preActivationJobCreate
 		environment = "environment: " + cleanManualApproval
 	}
 
+	// Set job-level GH_AW_INFO_APM_VERSION so the apm_pack step can reference it
+	// via ${{ env.GH_AW_INFO_APM_VERSION }} in its with: block
+	var activationJobEnv map[string]string
+	if data.APMDependencies != nil && len(data.APMDependencies.Packages) > 0 {
+		apmVersion := data.APMDependencies.Version
+		if apmVersion == "" {
+			apmVersion = string(constants.DefaultAPMVersion)
+		}
+		activationJobEnv = map[string]string{
+			"GH_AW_INFO_APM_VERSION": apmVersion,
+		}
+	}
+
 	job := &Job{
 		Name:                       string(constants.ActivationJobName),
 		If:                         activationCondition,
 		HasWorkflowRunSafetyChecks: workflowRunRepoSafety != "", // Mark job as having workflow_run safety checks
 		RunsOn:                     c.formatSafeOutputsRunsOn(data.SafeOutputs),
 		Permissions:                permissions,
 		Environment:                environment,
+		Env:                        activationJobEnv,
 		Steps:                      steps,
 		Outputs:                    outputs,
 		Needs:                      activationNeeds, // Depend on pre-activation job if it exists

pkg/workflow/aw_info_versions_test.go

@@ -221,6 +221,19 @@ func (c *Compiler) buildMainJob(data *WorkflowData, activationJobCreated bool) (
 		env["GH_AW_WORKFLOW_ID_SANITIZED"] = sanitizedID
 	}
 
+	// Set job-level GH_AW_INFO_APM_VERSION so the apm_restore step can reference it
+	// via ${{ env.GH_AW_INFO_APM_VERSION }} in its with: block
+	if data.APMDependencies != nil && len(data.APMDependencies.Packages) > 0 {
+		if env == nil {
+			env = make(map[string]string)
+		}
+		apmVersion := data.APMDependencies.Version
+		if apmVersion == "" {
+			apmVersion = string(constants.DefaultAPMVersion)
+		}
+		env["GH_AW_INFO_APM_VERSION"] = apmVersion
+	}
+
 	// Generate agent concurrency configuration
 	agentConcurrency := GenerateJobConcurrencyConfig(data)