Skip to content
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.

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

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

Closed
wants to merge 2 commits into from

Conversation

darcywong00
Copy link
Contributor

@darcywong00 darcywong00 commented May 7, 2024

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 keymanapp-test-bot bot added the user-test-missing User tests have not yet been defined for the PR label May 7, 2024
@darcywong00 darcywong00 added this to the A18S1 milestone May 7, 2024
@keymanapp-test-bot keymanapp-test-bot bot removed the user-test-missing User tests have not yet been defined for the PR label May 7, 2024
@darcywong00 darcywong00 linked an issue May 7, 2024 that may be closed by this pull request
@mcdurdin
Copy link
Member

mcdurdin commented May 8, 2024

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).

Base automatically changed from chore/common/minversions.sh to master May 8, 2024 18:16
@darcywong00
Copy link
Contributor Author

Replaced by #11399

@darcywong00 darcywong00 closed this May 9, 2024
@darcywong00 darcywong00 deleted the chore/common/min-version-md branch May 17, 2024 00:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

chore(common): make minimum-versions.md
2 participants