Make manifest-version optional in aw.yml#41687
Merged
Merged
Conversation
…xample Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
pelikhan
June 26, 2026 12:20
View session
Contributor
There was a problem hiding this comment.
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
resolveRepositoryPackageaccepts manifests that omitmanifest-version(remote/package-add path). - Added a compile-path test ensuring repository-root
aw.ymlvalidation succeeds whenmanifest-versionis omitted (local compile path). - Updated the reference documentation example to omit
manifest-version(andmin-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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
manifest-versionwas 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 toTestResolveRepositoryPackagepkg/cli/compile_repository_manifest_test.go— addsTestCompileWorkflows_AcceptsManifestWithoutManifestVersionfor the local compile pathdocs/reference/aw-yml-package-manifest.md— stripsmanifest-version(andmin-version) from the example, showing the minimal valid form: