search

keymanapp / keyman

Keyman cross platform input methods system running on Android, iOS, Linux, macOS, Windows and mobile and desktop web
https://keyman.com/
Other
372 stars 102 forks source link

chore(common): Add `minimum-versions.md` #11386

Closed darcywong00 closed 1 week ago

darcywong00 commented 1 week ago

Follows #11380 and fixes #11372

This adds a ~human-readable~ minimum-versions.md document which cross-references documentation and help files affected by updates to minimum-versions.inc.sh.

@keymanapp-test-bot skip

keymanapp-test-bot[bot] commented 1 week ago

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

mcdurdin commented 1 week ago

I think longer term, what we could do is this:

  1. Generate min-ver.md from min-ver.inc.sh, with a script in /resources/somewhere.
  2. In our common test build, we generate a new copy of min-ver.md and compare it to the version in-repo, and then fail the test build if they are not identical.

This would avoid us unintentionally getting the two files out of sync, allow us to track the version data easily, and avoid the complications of automatic commit etc.

@ermshiperete suggested in Slack:

Another idea: we could make min-ver.md a template file min-ver.md.in or so. In the CI build we replace the variables in the .in file with the values from min-ver.inc.sh and commit/push the result.

This sounds like a great idea, only challenge is making sure we pick up all the env vars in the .inc.sh so that the .md doesn't miss any. Thought: include a table at the bottom of the .md that lists all the env vars as parsed out from the file (or you could do a funky diff of before/after env, which I am doing for Windows build.sh right now so we could copy that).

darcywong00 commented 1 week ago

Replaced by #11399