Skip to content

docs(review): require changelog entry format - #3899

Merged
ashwinvaidya17 merged 2 commits into
open-edge-platform:mainfrom
ashwinvaidya17:docs/review/changelog-format
Nov 6, 2026
Merged

ashwinvaidya17 merged 2 commits into
open-edge-platform:mainfrom
ashwinvaidya17:docs/review/changelog-format

Conversation

@ashwinvaidya17

@ashwinvaidya17 ashwinvaidya17 commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Changelog review should verify entry format as well as presence. The existing instruction to ignore formatting could suppress checks required by the release convention.

  • Explicitly exempt changelog structure and entry format from the instruction to ignore style-only feedback.
  • Require the correct section, change-type emoji, bold scope, user-facing summary, author attribution, and actual PR URL.
  • Keep Copilot instructions and the authoritative changelog review skill aligned, with generic placeholders and metadata verification.
  • Preserve release-preparation exceptions, grouped credits, and unrelated historical entries.

Validation

  • uvx prek run --files .github/copilot-instructions.md .agents/skills/docs-changelog/SKILL.md — passed.
  • Commit hooks and git diff --check — passed.
  • Documentation-only; no runtime behavior or release artifacts changed.

Separate from v2.7.1 release preparation.

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>
Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>
Copilot AI balanced review requested due to automatic review settings November 6, 2026 10:40

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.

🟢 Approval recommended

No active review issues were identified for the documentation-only update to changelog review guidance.

No open issues 🎉

What changed in this PR

This documentation-only PR strengthens Anomalib’s changelog review guidance following the missed formatting checks in #3897. It aligns Copilot instructions with the changelog review skill without changing runtime behavior.

Changes:

  • Exempts changelog structure and entry format from the general instruction to ignore style-only issues.
  • Requires complete entries, including emoji, bold scope, summary, attribution, and a metadata-verified PR URL.
  • Preserves release-preparation exceptions, grouped credits, and unrelated historical entries.
File Description
.github/​copilot-instructions.md Adds explicit changelog format requirements and a concrete example.
.agents/​skills/​docs-changelog/​SKILL.md Aligns changelog review rules and checklist with the Copilot instructions.

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings November 6, 2026 10:43
@ashwinvaidya17
ashwinvaidya17 enabled auto-merge (squash) November 6, 2026 10:44

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.

🟢 Approval recommended

No active review issues are reported for the documentation-only updates to changelog review requirements.

No open issues 🎉

Review effort: Balanced

@ashwinvaidya17
ashwinvaidya17 merged commit 0e21c0a into open-edge-platform:main Nov 6, 2026
43 checks passed
@ashwinvaidya17
ashwinvaidya17 deleted the docs/review/changelog-format branch November 6, 2026 12:39
ashwinvaidya17 added a commit that referenced this pull request Nov 16, 2026
* fix(data): fix nan mask path casting and enum filtering in datasets (#3852)

* fix(data): fix nan mask path casting and enum filtering in datasets

* format fix

---------

Co-authored-by: andersendsa <199610634+andersendsa@users.noreply.github.com>

* feat(ui): add constraints to zoom scale and translations in ZoomProvider (#3851)

* fix(ui): add constraints to zoom scale and translations in ZoomProvider

* Update application/ui/src/components/zoom/zoom.tsx

Co-authored-by: Camilo <camilocolmenares7@hotmail.com>
Signed-off-by: Andersen Dsa  <andersendsa631@gmail.com>

* fix(ui): import zoom updater guard and sort imports

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* fix(ui): add pagination to Playwright fixtures

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

---------

Signed-off-by: Andersen Dsa  <andersendsa631@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>
Co-authored-by: andersendsa <199610634+andersendsa@users.noreply.github.com>
Co-authored-by: Camilo <camilocolmenares7@hotmail.com>
Co-authored-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* docs: align CLI and API examples with current public APIs (#3867)

* docs: align public API and CLI examples with current behavior

Fix evidence-backed documentation drift in install extras, CLI flags,
export types, class names, and Engine/Evaluator usage so examples match
the implemented public APIs.

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* docs: address Copilot review on CLI and example accuracy

Add required --model to predict docs, use latest checkpoint paths,
set EfficientAd train_batch_size=1, train before OpenVINO export, and
point the sample benchmark config at MVTecAD.

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* docs: use latest checkpoint path in CLI export example

Keep the export example aligned with the versioned results layout used
by training and predict.

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* test: keep Draem config loading offline in unit tests

Draem downloads the DTD dataset when dtd_dir is missing, and CI could not
reach that host. Point the from_config case at a local directory.

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* test: patch Draem config offline via temp YAML

Avoid dotted kwargs overrides in from_config unit tests by rewriting a
temporary Draem config that points dtd_dir at a local directory.

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

---------

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* chore(deps): update dependency mlflow to v3.17.2 [security] (#3876)

Signed-off-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>
Co-authored-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency dompurify to v3.4.17 [security] (#3874)

* chore(deps): update dependency dompurify to v3.4.17 [security]

Signed-off-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>
Signed-off-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>

* test(ui): fix image-list pagination mock

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

---------

Signed-off-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>
Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>
Co-authored-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>
Co-authored-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* docs: align examples with the current public API (#3880)

* docs: align examples with the current public API

Documented CLI flags, checkpoint paths, export calls, and class names
no longer match the parser and public constructors.

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* docs: save OpenVINO inference example output

* docs: clarify prediction visualization saving

---------

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* fix(model): keep PatchCore's batch size dynamic when exporting (#3853)

* fix(model): keep PatchCore's batch size dynamic when exporting

Signed-off-by: Varunika Rai <itsvarunikarai@gmail.com>

* docs(changelog): add entry for #3853

Signed-off-by: Varunika Rai <itsvarunikarai@gmail.com>

* test(model): use public pytest.MonkeyPatch in PatchCore tests

Signed-off-by: Varunika Rai <itsvarunikarai@gmail.com>

---------

Signed-off-by: Varunika Rai <itsvarunikarai@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>
Co-authored-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* docs: correct examples that drift from public APIs (#3890)

* docs: correct examples that drift from public APIs

Folder no longer accepts task, export examples named a removed datamodule and invalid compression values, and the Lightning badge and OpenVINO checkpoint path did not match the current install and results layout.

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* docs(engine): use enum names in examples

---------

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* fix(data): disable broken MVTec autodownloads (#3893)

* fix(data): disable broken MVTec autodownloads

Preserve local dataset support and provide manual-download guidance.\nTrack restoration in #3892.

* docs: link MVTec changelog to PR and author

* fix(deps): npm audit fixes [security] (#3884)

Co-authored-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>

* docs(review): require changelog entry format (#3899)

* docs(review): require changelog entry format

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* docs(review): use generic changelog example

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

---------

Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>

* chore(deps): update github actions (#3887)

Signed-off-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>
Co-authored-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>

* chore(deps): update dependency pillow to v13 [security] (#3919)

Signed-off-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>
Co-authored-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>

---------

Signed-off-by: Andersen Dsa  <andersendsa631@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwin.vaidya@intel.com>
Signed-off-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>
Signed-off-by: Varunika Rai <itsvarunikarai@gmail.com>
Co-authored-by: Andersen Dsa <andersendsa631@gmail.com>
Co-authored-by: andersendsa <199610634+andersendsa@users.noreply.github.com>
Co-authored-by: Camilo <camilocolmenares7@hotmail.com>
Co-authored-by: Ashwin Vaidya <ashwin.vaidya@intel.com>
Co-authored-by: oep-renovate[bot] <212772560+oep-renovate[bot]@users.noreply.github.com>
Co-authored-by: varunika rai <itsvarunikarai@gmail.com>
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.

2 participants