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
Copy Markdown
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
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 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 Deprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0. label Feb 25, 2026
@danielmeppiel danielmeppiel merged commit 7cba263 into microsoft:main Feb 25, 2026
5 of 6 checks passed
danielmeppiel added a commit that referenced this pull request Apr 30, 2026
…#1073)

* docs(notice): rename NOTICE.md -> NOTICE; add CLA third-party section

Two changes, one file rename:

1. Rename NOTICE.md -> NOTICE, matching the Apache / CNCF convention used
   by upstream third-party-attribution files (kubernetes-sigs/kro,
   kubernetes-sigs/headlamp, etc.). The .md extension was non-idiomatic
   for a generated legal artifact -- NOTICE files are read by tooling
   (license scanners, SBOM generators) that match on the bare filename.
   Generator (scripts/generate-notice.py), Makefile target, and the
   NOTICE Drift Check workflow are all updated to operate on the
   extension-less path.

2. Add a 'Submitted on behalf of a third-party' section to NOTICE,
   crediting five contributors whose pull requests landed before the
   microsoft-github-policy-service CLA bot recorded a signature on
   file. The repo transferred from danielmeppiel/awd-cli to the
   microsoft org; some early PRs predate CLA enforcement, and we
   could not retroactively reach all contributors. Mirrors section 7
   of common CLA texts (the wording adopted by CNCF NOTICE files).

   Driven by a new _third_party_submissions block in
   scripts/notice-metadata.yaml -- legally-significant wording stays
   alongside the per-component data, not buried in code.

   Contributors named (verified via Check Runs API against the
   microsoft-github-policy-service app, license/cla check on every
   merged PR by each suspected author):
     - @pofallon  (PR #4)
     - @richgo    (PRs #8, #25, #26, #33, #34)
     - @ryanfk    (PR #92 -- bot ran with conclusion=null,
                  output: 'Contributor License Agreement is not agreed yet.')
     - @foutoucour (PR #108)
     - @Jah-yee   (PR #184)

   Listed contributors who later sign the CLA (or who were signed
   under a different GitHub account at the time) can request removal
   via issue.

Co-authored-by: Copilot <[email protected]>

* docs(notice): trim third-party section preamble

Strip the historical/CNCF-citation paragraph and the verbatim CLA-section-7
quote. Keep only the active sentence (what the listing means + how to
request removal).

Co-authored-by: Copilot <[email protected]>

* docs(notice): address PR #1073 review

Three fixes from copilot-pull-request-reviewer:

1. Drop spurious leading '---' separator in the third-party-submissions
   renderer. render_component already ends each component with '---\n\n',
   so prepending another '---' produced two consecutive separators in
   NOTICE. Verified: separator count dropped from 17 to 16.

2. Sweep stale 'NOTICE.md' references in scripts/generate-notice.py
   (top-level docstring, Modes section, ComponentMeta and DepSpec field
   docstrings). The constant was renamed; the docs lagged.

3. Append (#1073) PR refs to both CHANGELOG entries; ASCII-correct the
   arrow ('->' instead of '->').

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Deprecated: use type/docs. Kept for issue history; will be removed in milestone 0.10.0.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants