Release Review: DeviceAuthenticity r1.1 (alpha)

[camara-release-automation]

Release Review: r1.1 alpha

This PR finalizes the reviewable release content for the active snapshot.

Edit and review this PR before merging it into the release snapshot. After Codeowner and Release Management approval, merging this PR creates the draft release.

Release contents

API	Version	Status	Comparison target
device-authenticity	0.1.0-alpha.1	alpha	N/A

Dependencies: Commonalities r4.4, ICM r4.2

Codeowner Actions

Tick each box once done. Ticking the last box — "The release is ready for Release Management review" — starts the Release Management review.

• Update the CHANGELOG

  What to do:

  • Copy all API-consumer-relevant changes from the provided list into the appropriate Breaking changes / Added / Changed / Fixed / Removed sections for each API. List breaking changes both in Breaking changes and in their normal change category.
  • Do not copy administrative, tooling-only, or internal maintenance changes unless they affect API consumers.
  • For each API, fill the CHANGELOG against the stated comparison target, following the release-type rules at the top of the CHANGELOG.

• Document deferred validation warnings (and hints)

  What to do:

  • Check the CAMARA Validation comment on this PR for warnings and hints.
  • For each warning you do not fix, document it in an issue: include a copy of the validation summary line(s) and the reason the fix is deferred.
  • Document in the same way any validation hint that is applicable to the API and needs to be fixed later.
  • You may group several findings into one issue or split them across issues — either is fine.
  • List the documenting issue(s) in a comment on this PR.
  • Note: documenting deferred warnings is optional but recommended for alpha pre-releases, and mandatory for rc pre-releases and public releases.

• The release is ready for Release Management review

  Check that:

  • All mandatory release assets for the declared status(es) are present (see the table below "Required release assets per API status" by expanding the arrow);
  • API documentation and test cases are adequate for the target status.

  Tick this box to confirm readiness and to start the Release Management review.

Release Management Actions

The following actions and checks are done by a Release Management reviewer before approving the PR:

• Assign the Release Management reviewer(s) as assignee(s) of this PR
• CHANGELOG follows the release documentation rules
• Breaking changes are documented and version updates follow SemVer rules
• Mandatory release assets are present for each API according to its status
• All remaining validation warnings are documented in issues and the reasons for deferral are defensible
• Content findings needing a main PR are collected as sub-issues of one issue titled Release r1.1 review findings (see Recording review findings)

Required release assets per API status

Nr	Asset	alpha	rc	initial public	stable public
1	Release Plan	M	M	M	M
2	API Definition(s)	M	M	M	M
3	Commonalities compliance	O	M	M	M
4	API Documentation	M	M	M	M
5	User Stories	O	O	O	M
6	Test Cases (basic)	O	M	M	M
7	Test Cases (enhanced)	O	O	O	M
8	API Description	O	O	M	M

M = Mandatory, O = Optional — Full documentation

Valid next actions for codeowners

• Merge this PR when all Codeowner Actions and Release Management Actions are complete and the required approvals are present — creates the draft release
• Use /discard-snapshot <reason> in the Release Issue to discard this snapshot, return to planned, and update content on main

---

Snapshot: r1.1-9e574b4

[camara-validation]

CAMARA Validation — PASS (with warnings)

0 errors, 13 warnings, 4 hints | Profile: standard

View full results

Warnings SHOULD be documented in one or more issues before this release — see the Codeowner Actions in the PR description.

[hdamker]

Would you mind to address some of the warnings https://github.com/camaraproject/DeviceAuthenticity/actions/runs/38856185530 first on main? Some of them came with r4.4 but others existed already before.

[ALIIQBAL786]

Hi @hdamker, thank you for the feedback and for taking the time to review!

All 13 warnings and 4 hints have been addressed in PR #27, which has now been merged into main. The latest validation run shows 0 errors, 0 warnings, and 0 hints: https://github.com/camaraproject/DeviceAuthenticity/actions/runs/38862347744

The fixes covered all three engines: Spectral (missing maxLength/format/minimum/maximum on schema properties, apiRoot default), Python checks (mandatory info.description template blocks, externalDocs, placeholder README.MD removal), and GPLint (feature tag indentation, unused Examples column).

Would you be happy to approve this PR now that main is clean? Really appreciate your support on this.

[hdamker]

Would you be happy to approve this PR now that main is clean? Really appreciate your support on this.

@ALIIQBAL786 the changes from PR #27 are not part of this snapshot. You need to discard the snapshot via #21 and then create a new snapshot.

BTW: as this is the very first release in the repository the CHANGELOG should contain only a "added" entry with the initial functionality ... everything is new in the release, there is not release to compare with hence also nothing "fixed". Who wants to get the full history can look on the commits.