Skip to content

Make manifest-version optional in aw.yml#41687

Merged
pelikhan merged 1 commit into
mainfrom
copilot/make-manifest-version-optional
Jun 26, 2026
Merged

Make manifest-version optional in aw.yml#41687
pelikhan merged 1 commit into
mainfrom
copilot/make-manifest-version-optional

Conversation

Copilot AI commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

manifest-version was already optional in the JSON schema and Go parsing code (omitting it defaults to "1"), but there was no explicit test coverage for the omitted case, and the reference doc example implied it was required.

Changes

  • pkg/cli/add_package_manifest_test.go — adds "accepts manifest without manifest-version" sub-test to TestResolveRepositoryPackage
  • pkg/cli/compile_repository_manifest_test.go — adds TestCompileWorkflows_AcceptsManifestWithoutManifestVersion for the local compile path
  • docs/reference/aw-yml-package-manifest.md — strips manifest-version (and min-version) from the example, showing the minimal valid form:
name: Repo Assist
emoji: 🤖
description: Friendly repository automation for review and issue triage
files:
  - workflows/review.md

…xample

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI requested a review from pelikhan June 26, 2026 12:20
@pelikhan pelikhan marked this pull request as ready for review June 26, 2026 12:22
Copilot AI review requested due to automatic review settings June 26, 2026 12:22
@pelikhan pelikhan merged commit 296221a into main Jun 26, 2026
@pelikhan pelikhan deleted the copilot/make-manifest-version-optional branch June 26, 2026 12:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 aligns the aw.yml package manifest documentation and test coverage with existing behavior: manifest-version is optional and defaults to "1" when omitted, and both the remote package install path (gh aw add) and local repository compile validation (gh aw compile) now have explicit tests for the omitted case.

Changes:

  • Added a subtest to ensure resolveRepositoryPackage accepts manifests that omit manifest-version (remote/package-add path).
  • Added a compile-path test ensuring repository-root aw.yml validation succeeds when manifest-version is omitted (local compile path).
  • Updated the reference documentation example to omit manifest-version (and min-version) to reflect the minimal valid form.
Show a summary per file
File Description
pkg/cli/add_package_manifest_test.go Adds coverage that repository package resolution accepts aw.yml without manifest-version.
pkg/cli/compile_repository_manifest_test.go Adds coverage that local gh aw compile manifest validation accepts aw.yml without manifest-version.
docs/src/content/docs/reference/aw-yml-package-manifest.md Updates the example manifest to reflect that manifest-version (and min-version) are optional.

Review details

Tip

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

  • Files reviewed: 3/3 changed files
  • Comments generated: 0
  • Review effort level: Low

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.

3 participants