erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-10 02:45:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
spiegel-keyman/resources/build/README.md
Marc Durdin f394245636 maint(common): consolidate builder scripts 
Clarifies the confusing builder.inc.sh / build-utils.sh distinction by
giving the scripts more appropriate names. Most build scripts should use
builder-full.inc.sh; some helper scripts can use builder-basic.inc.sh.
Documented in resources/build/README.md.

Renames:
* resources/build/builder.inc.sh to resources/build/builder-full.inc.sh
* resources/build/build-utils.sh to resources/build/builder-basic.inc.sh

Other changes:
* Moves Android-specific functions out of builder-basic.inc.sh and into
  android/build.sh.
* Renames functions in builder-basic.inc.sh

More functions may be moved from builder-basic.inc.sh into utils.inc.sh
or other scripts in the future.

Fixes: #14065
Build-bot: build all
Test-bot: skip
2025-08-02 08:11:24 +10:00

1.5 KiB
Raw Blame History

Release builds

A release is triggered nightly whenever a pull request has been merged to the branch; it runs from a TeamCity build configuration that runs increment-version.sh and then uploads the resulting HISTORY.md to https://downloads.keyman.com/history/HISTORY.md.

To manually make a release (for example if a build falls over for a transient error or there was a build configuration problem), create a new PR that targets the branch, merge it, and then run the Trigger Release Builds build configuration for that branch. If you have no changes, see that as an opportunity to improve documentation, including this file...

Various tools

builder-basic.inc.sh, builder-full.inc.sh

There are two wrappers for builder.inc.sh:

  • resources/build/builder-basic.inc.sh - Keyman-specific builder-based script that also sets version environment, repo base path, and other environment variables
  • resources/build/builder-full.inc.sh - Keyman-specific builder-based script, calls builder-basic.inc.sh, sets cwd to script path, and on exit verifies that builder functions were used appropriately.

All build.sh scripts should use builder-full.inc.sh. Some helper scripts may use builder-basic.inc.sh. No scripts in this repo (apart from tests) should use builder.inc.sh directly.

builder.inc.sh is documented in builder.md

jq/jq-win64

jq resp. jq-win64.exe is used by various builds for json query.

Official source: https://stedolan.github.io/jq/. License