Skip to content

Latest commit

 

History

History
92 lines (59 loc) · 3.16 KB

RELEASING.md

File metadata and controls

92 lines (59 loc) · 3.16 KB
Raw

Releasing

1. Checking bugs and technical debt

Lint checks

Android development tools provide linter to check common errors. Use ./gradlew :app:lint to run the linter and produce (human readable) reports as HTML file located at app/build/reports/lint-results.html.

Important

Check no new warning was introduced before releasing.

SonarCloud analysis

The AdAway application source code is analyzed by SonarCloud to find bugs, code smells and compute technical debt. While the overall score may be not perfect, each new release should not increase it.

Important

Check no new bug nor debt was introduced before releasing.

2. Updating application version

Each version has its own number that follows the Semantic Versioning principle (starting from version 4).

Important

Update application version name (appName) and code (appCode) from the gradle/libs.versions.toml catalog file.

3. Updating the changelog

The AdAway project provides a global changelog.

Important

Update the changelog to let users know what is inside each new version before releasing it.

4. Building release APK

The release apk must be built using the release flavor (not debug). Check the contributing guide for building instructions.

Important

Rename to release apk file to follow the format: AdAway-<version_name>-<yyyymmdd>.apk

Example: AdAway-6.1.2-20220817.apk for the version 6.1.2 built the 08/17/22.

5. Distributing release

Before sharing the any release, remember to test it. Release variant apk does not behave like debug variant. Same goes for real device versus emulator.

Important

Final tests should be done with release apk variant on real device.

Once tested, releases are posted on XDA development thread using the following template:

Hi all,

<welcoming message about the new version>

[U][SIZE="4"]Changelog:[/SIZE][/U]
[LIST]
[*] Item 1
[*] Item 2
[*] ...
[*] Item n
[/LIST]

[U][SIZE="4"]Thanks:[/SIZE][/U]

Special thanks to <contributors> for theirs contributions and <bug reporters> for theirs helpful bug reports.

[U][SIZE="4"]Download:[/SIZE][/U]

[URL="https://app.adaway.org/adaway.apk"]AdAway <application version>[/URL]

Beta releases

The beta releases are only announced in the XDA development thread.

Stable releases

The stable releases are distributed through GitHub releases and F-Droid store and are posted of the first post of XDA development thread. Once ready, create and push a tag on GitHub repository using vX.Y.Z format (or vX.Y.Zb for pre-releases). To publish the application in GitHub:

  • Create a new version based on this tag,
  • Copy the changelog part related to the version as description of the release,
  • Upload apk binary to the release.

Pushing a tag will publish the application to F-Droid store. It might takes some days to update but if it does not, build logs are available at the following address: https://monitor.f-droid.org/builds/log/org.adaway/<versioncode>.