Skip to content

documentation: Update README.md: missing version in the apm.yml example#108

Merged
danielmeppiel merged 2 commits intomicrosoft:mainfrom
foutoucour:patch-1
Feb 25, 2026
Merged

documentation: Update README.md: missing version in the apm.yml example#108
danielmeppiel merged 2 commits intomicrosoft:mainfrom
foutoucour:patch-1

Conversation

@foutoucour
Copy link
Contributor

@foutoucour foutoucour commented Feb 25, 2026

Pull Request

⚡ Quick Start - Use Specialized Templates

For better guidance, consider using our specialized templates:

Description

I tried the example as it is and got the error:

/tmp/apm-test❯ apm install
Installing dependencies from apm.yml...
Failed to parse apm.yml: Missing required field 'version' in apm.yml

I suggested version 1.0.0 as an example, but it might be worth an additional comment.

the link to the sample project was outdated.

Type of Change

🏷️ IMPORTANT: Apply the appropriate label after creating this PR:

  • 🚀 New Feature → Apply label: enhancement or feature
  • 🐛 Bug Fix → Apply label: bug or fix
  • 📖 Documentation → Apply label: documentation or docs
  • 🔧 Other Changes → No specific label needed
  • 🚫 Exclude from Release Notes → Apply label: ignore-for-release

Testing

  • Tested locally
  • All existing tests pass
  • Added tests for new functionality (if applicable)

Checklist

  • ✅ LABEL APPLIED: I have applied the appropriate label to this PR
  • Code follows project style guidelines
  • Updated documentation if needed
  • Updated CHANGELOG.md for significant changes

Fixes # (issue)

I tried the example as it is and got the error:
```
/tmp/apm-test❯ apm install
Installing dependencies from apm.yml...
Failed to parse apm.yml: Missing required field 'version' in apm.yml
```
I suggested the version 1.0.0 as example, but it might worth an additional comment.
Copilot AI review requested due to automatic review settings February 25, 2026 21:38
Copy link
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 fixes a documentation issue in the README.md where the example apm.yml configuration was missing the required version field, causing the example to fail when users tried to run it.

Changes:

  • Added version: 1.0.0 to the apm.yml example in README.md

@danielmeppiel danielmeppiel self-requested a review February 25, 2026 21:44
@danielmeppiel danielmeppiel added the documentation Improvements or additions to documentation label Feb 25, 2026
@danielmeppiel danielmeppiel merged commit 7cba263 into microsoft:main Feb 25, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants