Skip to content

Commit

Permalink
build: finalize for release
Browse files Browse the repository at this point in the history
- Update version values
- Update CHANGELOG
- Add a fastlane changelog file for the current release version
- Add a fastlane changelog file for the prior release version (v1.1.2,
  versionCode 4) which was overlooked in preparing that release.
- Improve formatting of fastlane full description
- Add explanation of a permission to README.md previously overlooked
  but noted on F-Droid's RomanDigital webpage.
- Further clarify README.md
  • Loading branch information
dfyockey committed Oct 29, 2024
1 parent e97455d commit d050480
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 10 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ This project aims to adhere to [Semantic Versioning](https://server.org).

Regarding project commits: As of 2024-08-23, this project aims to adhere to the [Conventional Commits](https://www.conventionalcommits.org) standard. While the standard makes recommendations, it does not limit commit type or scope; consequently, neither type nor scope is limited to those recommendations in the project commits.

## [1.2.0] - 2024-10-29

### Added

* `Cancel` and `Save` buttons to both widget and app settings activities (addresses Issue #12).

## [1.1.2] - 2024-10-19

### Fixed
Expand Down
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ in the normal manner for the particular Android version.

The USE_EXACT_ALARM permission is set by this app. This permission is
necessary on Android 13 and greater to enable the widget to provide an
accurate time display. The permission cannot be disabled without modifying the source code.
accurate time display without inconveniencing the user by asking for the permission.
It cannot be disabled without modifying the source code.

The SCHEDULE_EXACT_ALARM permission is also set by this app and is
necessary on Android 12 for the same reason as the USE_EXACT_ALARM
Expand All @@ -69,17 +70,27 @@ permission will cause inaccuracy in the widget's time display.

Android versions 11 and lower allow setting of exact alarms by default.

An additional permission, net.diffengine.romandigitalclock.DYNAMIC_RECEIVER_NOT_EXPORTED_PERMISSION,
is set by this app. This permission was set in the app build process by use of a particular Android
library required to enable the app to function as expected on versions of Android 12 and earlier
(i.e. prior to API 33). It cannot be disabled without modifying the source code. As noted in
an fdroidserver commit, "it's basically just an internal hack, rather than a real permission." For
a more technical explanation of this "permission", see the full commit message at
https://gitlab.com/fdroid/fdroidserver/-/merge_requests/1336/diffs?commit_id=71697f9c88ec73980f63be5955f36cdc3ba7a02c

## Known Issues

After updating the app, a widget that had previously been added to the home screen may stop updating. It may be 'kickstarted' by simply opening and then closing the widget's settings screen. For a bit more info on this, see the first FAQ question below.

The 'Align to Divider' option does not correctly align the display when a variable width font is used.

The RomanDigital app will run on a 5th Generation Amazon Kindle Fire, which is based on Android 5.1, but the widget will not. RomanDigital has not been tested on other Fire versions.

## FAQ (Foremost Anticipated Questions)

> Q: "I just updated RomanDigital, and now the widget doesn't work! What happened?"
>
> A: The widget "ticks" are scheduled in advance for technical reasons, and the widget that's part of the updated app likely won't receive any "ticks" scheduled for the previous app's widget. In which case, it stops :slightly_frowning_face: The workaround right now to get the widget going again is to "kickstart" it by simply opening and then closing a settings screen from either the widget or the app. I hope to make post-update widget restart either more elegant or entirely automatic at some point.
> A: The widget "ticks" are scheduled in advance for technical reasons, and the widget that's part of the updated app may not receive "ticks" previously scheduled for the widget's earlier version. In such a case, it stops :slightly_frowning_face: The workaround right now to get the widget going again is to "kickstart" it by simply opening and then closing a settings screen from either the widget or the app. I hope to make post-update widget restart either more elegant or entirely automatic at some point.
> Q: "Why does the position of the divider change when 'Align to Divider' is selected? Isn't it supposed to stay in one place?"
>
Expand Down
4 changes: 2 additions & 2 deletions app/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ android {
applicationId = "net.diffengine.romandigitalclock"
minSdk = 21
targetSdk = 34
versionCode = 4
versionName = "1.1.2"
versionCode = 5
versionName = "1.2.0"

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
}
Expand Down
2 changes: 2 additions & 0 deletions fastlane/metadata/android/en-US/changelogs/4.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fixed:
* App clock text being too large when user has selected a font in their Android settings that effects app fonts and that does not provide a monospace font. (Note: While this fix enables use of variable-width fonts, the "Align to Divider" option functionality does not work correctly for such fonts.)
2 changes: 2 additions & 0 deletions fastlane/metadata/android/en-US/changelogs/5.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added:
* `Cancel` and `Save` buttons to both widget and app settings activities.
10 changes: 4 additions & 6 deletions fastlane/metadata/android/en-US/full_description.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ The RomanDigital app provides a clock of unique style that can be used to repurp
For more personal use, the RomanDigital widget makes a distinctive addition to a device's Home screen.

RomanDigital includes features expected in an ordinary digital clock app, such as:
<ul>
<li>Choice of 12 or 24 hour format</li>
<li>Optional AM/PM indicator (uniquely integrated into the time display)</li>
<li>Option to keep display on when app is in the foreground</li>
<li>Display in either portrait or landscape</li>
</ul>
* Choice of 12 or 24 hour format
* Optional AM/PM indicator (uniquely integrated into the time display)
* Option to keep display on when app is in the foreground
* Display in either portrait or landscape

For more detailed information including a FAQ list, please see the README.md file accompanying the RomanDigital source code.

Expand Down

0 comments on commit d050480

Please sign in to comment.