refactor: reduce release note body size and add cmd - #1527
Conversation
|
We might ant to think about the attestations management strategy for repos... |
|
Just tried this on a fake repo (only including a fake file with its attestation) and here is the result 
|
I like it ! What if we included one example as part of the release statement. To the first artifact for example.. so that users know how to pass in the |
|
Updating the PR with extra content because the command expects extra flag 
|
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
|
Awesome, thanks @SMoraisAnsys - 958c5c2 |
|
After some die and retry, here is the latest result. Note that the file is an extra one that I manually attest in my custom release workflow :) 
|
RobPasMue
left a comment
RobPasMue
left a comment
There was a problem hiding this comment.
LGTM! thanks for this enhancement @SMoraisAnsys !
There was a problem hiding this comment.
🟡 Changes recommended
The new attestation example discovery loop can be unbounded/fragile (word-splitting from $(find ...) and potentially many gh attestation verify calls), which risks slowdowns or rate limiting on large releases.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the release-github composite action’s autogenerated release-note content to be shorter on large releases, while still guiding users on verifying artifact attestations and locating downloadable attestation bundles.
Changes:
- Refactors the “Artifact Attestations” release-notes section to avoid enumerating commands for every artifact and instead provide a concise generic command plus an optional concrete example.
- Adds a link to the repository’s
/attestationspage and updates action documentation to recommendattestations: readpermission when using attestation features. - Adds a changelog fragment documenting the refactor.
File summaries
| File | Description |
|---|---|
| release-github/action.yml | Shortens autogenerated release-note attestation guidance; adds attestation download link and token-permission guidance; introduces logic to pick an example attested artifact. |
| doc/source/changelog/1527.miscellaneous.md | Adds changelog entry for the release-note refactor. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
moe-ad
left a comment
moe-ad
left a comment
There was a problem hiding this comment.
LGTM!
I left a minor comment, just for consistency regarding where permission related information should be documented.
Refactor the release note body that can be autogenerated to reduce it's size (we have many repos where the number of elements is large. An example is illustrated below with
pyansys-geometry'slatest release noteAlso, the content of the release note contains extra information to let users know that they can directly download attestations from the projets repo
$REPO_URL/attestations. See #1527 (comment) for the result on a dummy repo.