Skip to content

ci(nightly): show per-PR changelog notes on nightly updates - #1376

Merged
A-EDev merged 2 commits into
mainfrom
ci/nightly-notes
Oct 20, 2026
Merged

A-EDev merged 2 commits into
mainfrom
ci/nightly-notes

Conversation

@A-EDev

@A-EDev A-EDev commented Oct 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Each PR with a user-visible change adds one note to .github/nightly-notes/ (## New, ## Improved or ## Fixed with short bullets). One file per PR, so open PRs never conflict.
  • .github/scripts/nightly_notes.py validates the notes and merges them, newest first, into one Markdown body.
  • The Publish nightly job now sets that body under the existing "Built from ... by run N" line. The update screen already renders release Markdown (parseReleaseNotes), so nightly testers see the changes grouped by section with linked issues.
  • The Checks job fails on a malformed note.
  • AGENTS.md gains the rule, and the folder has a README with the format.
  • This PR carries its own note.

Related issue

Closes #1330

Change type

  • Bug fix
  • Feature
  • Refactor or maintenance
  • Build, packaging, or CI
  • Documentation

Validation

  • ./gradlew :app:assembleGithubDebug (no app code changed)
  • ./gradlew :app:testGithubDebugUnitTest (no app code changed; ReleaseNotesTest already covers the intro and section shape)
  • python3 .github/scripts/nightly_notes.py --check: 1 note valid
  • Merge output checked with several notes (newest first per section, fixed section order), with an empty folder (intro only), and with malformed notes (bad name, unknown section, bullet before a heading, free text, em-dash: all reported, exit 1)
  • actionlint with shellcheck on build.yml: clean apart from the SC2016 info that main already has
  • I manually tested the affected behavior on an Android device or emulator.

Test device and Android version:

Screenshots or recordings

Risk and compatibility

  • The Publish nightly job now checks out .github/nightly-notes and .github/scripts with a sparse checkout before downloading the APK.

  • Notes cover every change since the last stable release; at each stable release they are folded into release-notes.md and the v*.txt changelog and deleted.

  • The change does not introduce secrets, private data, or unexpected telemetry.

  • New user-facing text uses Android string resources.

  • Dependency and lockfile changes are intentional and limited to this PR.

  • Room schema changes include the required version bump and migration, or this PR does not change the Room schema.

  • Breaking changes and upgrade steps are clearly documented.

Copilot AI balanced review requested due to automatic review settings October 20, 2026 15:16

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@github-actions github-actions Bot added documentation Improvements or additions to documentation ci GitHub Actions and repository automation labels Oct 20, 2026
@A-EDev
A-EDev merged commit dfd1a03 into main Oct 20, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci GitHub Actions and repository automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Add either changelogs or name tag of the said release we are being prompted to download.

2 participants