Skip to content

Update android releases page with more details around each release type #2648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update android releases page with more details around each release type #2648

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd0806c
Mention removing beta labels for production release
dshokouhi Apr 22, 2025
088e960
Update release.md
dshokouhi Apr 23, 2025
a2d3a04
apply nitpicks
dshokouhi Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/android/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ You can download pre-built APKs for every commit on the `main` branch from the [
### Internal testing

- Internal testers validate the release build to ensure functionality.
- Every approved and merged PR is pushed to the internal beta channel on Google Play Store for immediate feedback. This is the only way to do real‑world testing for Android Auto/Automotive, as the debug builds will not show up in an actual vehicle.
- Due to the app's complexity, not all features can be tested exhaustively during this phase.

### Weekly beta releases

- Every week, the latest version of the `main` branch is pushed to the **open beta** channel.
- Every Saturday at 9pm PST, the latest `main` build is pushed to the **open beta** channel.
- Before that cutoff (Friday or Saturday), update the beta changelog to highlight new features and breaking changes.
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we can't add a flag like we do for 'beta' in companion docs to identify this as a 'task'. This is blend into information about something fully automated.

Copy link
Member Author

Choose a reason for hiding this comment

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

hmm well not everything is actually documented in the companion app docs, generally I try to go by the most recent commits that were merged and anything user facing I try to highlight and call out where they may see it like in settings. Most of the features are easy to write for but sometimes they are complex and 1 sentence may not be enough :) For something more important like a Breaking Change we probably def want to flag for that

- Open beta users help test the application in real-world scenarios and report issues.

:::note
Expand All @@ -43,7 +45,12 @@ You can join the beta program directly through the [Google Play Store](https://p

### Production release

If the beta version is stable and approved by maintainers, it is promoted to **production**, making it available to all users.
If the beta version is stable and approved by maintainers, it is promoted to **production**, making it available to all users. The following steps need to be checked for each release:

- Update the change log to include all latest changes and the version number to the latest beta
- Uncheck the pre-release checkbox in GitHub for the latest beta
- Prepare companion docs PR removing all beta labels for the release, PR should be merged once Google approves the release
- Notify Community Manager and Android Discord channel about the upcoming release and highlights for social media

:::note
You can find the app on the [Google Play Store](https://play.google.com/store/apps/details?id=io.homeassistant.companion.android).
Expand Down