Skip to content

maint(linux): allow to skip API check#14699

Merged
ermshiperete merged 2 commits intomasterfrom
maint/linux/10454_allowSkipAPI
Sep 10, 2025
Merged

maint(linux): allow to skip API check#14699
ermshiperete merged 2 commits intomasterfrom
maint/linux/10454_allowSkipAPI

Conversation

@ermshiperete
Copy link
Copy Markdown
Contributor

This change adds an option to skip the API checks during a build. This can be done by adding the trailer Keyman-Api-Check: skip to the PR description.

Fixes: #10454
Test-bot: skip
Keyman-Api-Check: skip

@keymanapp-test-bot
Copy link
Copy Markdown

keymanapp-test-bot bot commented Sep 5, 2025

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

  • Android
    • Keyman for Android apk - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices for Android 16.0 apk - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for Android apk - build : all tests passed (no artifacts on BuildLevel "build")
    • KeyboardHarness apk - build : all tests passed (no artifacts on BuildLevel "build")
    • Keyman for Android 16.0 apk - build : all tests passed (no artifacts on BuildLevel "build")
    • KMSample1 apk - build : all tests passed (no artifacts on BuildLevel "build")
    • KMSample2 apk - build : all tests passed (no artifacts on BuildLevel "build")
  • Developer
    • Keyman Developer - build : all tests passed (no artifacts on BuildLevel "build")
    • Compiler Regression Tests - build : all tests passed (no artifacts on BuildLevel "build")
    • kmcomp.zip - build : all tests passed (no artifacts on BuildLevel "build")
  • iOS
    • Keyman for iOS (simulator image) - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for iOS (simulator image) - build : all tests passed (no artifacts on BuildLevel "build")
    • TestFlight internal PR build version - 19.0.114 (0.14699.14507)
  • Keyboards
    • Test Keyboards - build : all tests passed (no artifacts on BuildLevel "build")
  • macOS
    • Keyman for macOS - build : all tests passed (no artifacts on BuildLevel "build")
  • Web
    • KeymanWeb Test Home - build : all tests passed (no artifacts on BuildLevel "build")
  • Windows
    • Keyman for Windows - build : all tests passed (no artifacts on BuildLevel "build")
    • FirstVoices Keyboards for Windows - build : all tests passed (no artifacts on BuildLevel "build")
    • Text Editor (32 bit) - build : all tests passed (no artifacts on BuildLevel "build")
    • Text Editor (64 bit) - build : all tests passed (no artifacts on BuildLevel "build")

@keymanapp-test-bot keymanapp-test-bot bot added this to the A19S11 milestone Sep 5, 2025
@github-actions github-actions bot added resources/ linux/ maint Maintenance work -- continuous integration, build scripts, infrastructure docs and removed linux/ labels Sep 5, 2025
@ermshiperete ermshiperete force-pushed the refactor/resources/shellcheck branch from 2ba64ff to a9597b5 Compare September 5, 2025 17:02
This change adds an option to skip the API checks during a build.
This can be done by adding the trailer `Keyman-Api-Check: skip`
to the PR description.

Fixes: #10454
Test-bot: skip
Keyman-Api-Check: skip
@ermshiperete ermshiperete force-pushed the maint/linux/10454_allowSkipAPI branch from 02ba8b3 to 612cd01 Compare September 5, 2025 17:04
@github-actions github-actions bot added linux/ and removed linux/ labels Sep 5, 2025

#
# Check the Keyman-Api-Check command whether or not to run API checks.
# Any value other than 'ignore' or no Keyman-Api-Check command will run
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Any value other than 'ignore' or no Keyman-Api-Check command will run
# Any value other than 'skip' or no Keyman-Api-Check command will run

set -o noglob
IFS=$'\n'
prbody="$(echo "${prinfo}" | "${JQ}" -r '.body')"
prApiCheck="$(echo "${prbody}" | grep 'Keyman-Api-Check:' | cut -d: -f 2 - | tr -d '[:space:]')"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember with Test-bot we had the problem that it didn't check start-of-line. Should we tweak our grep here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Base automatically changed from refactor/resources/shellcheck to master September 8, 2025 07:09
Addresses code review comments.

Co-Authored-By: Marc Durdin <marc@durdin.net>
@github-actions github-actions bot added linux/ and removed linux/ labels Sep 8, 2025
Comment on lines +58 to +59
prbody="$(echo "${prinfo}" | "${JQ}" -r '.body')"
prApiCheck="$(echo -e "${prbody}" | grep '^Keyman-Api-Check:' | cut -d: -f 2 - | tr -d '[:space:]')"
Copy link
Copy Markdown
Contributor

@Markus-SWAG Markus-SWAG Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
prbody="$(echo "${prinfo}" | "${JQ}" -r '.body')"
prApiCheck="$(echo -e "${prbody}" | grep '^Keyman-Api-Check:' | cut -d: -f 2 - | tr -d '[:space:]')"
prApiCheck="$(echo "${prinfo}" | "${JQ}" '.body["Keyman-Api-Check"]')"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately the suggestion doesn't work.

@ermshiperete ermshiperete merged commit 0cb5d5e into master Sep 10, 2025
29 checks passed
@ermshiperete ermshiperete deleted the maint/linux/10454_allowSkipAPI branch September 10, 2025 07:31
@github-project-automation github-project-automation bot moved this from Todo to Done in Keyman Sep 10, 2025
@keyman-server
Copy link
Copy Markdown
Collaborator

Changes in this pull request will be available for download in Keyman version 19.0.116-alpha

ermshiperete added a commit that referenced this pull request Sep 17, 2025
Fix broken test build trigger for `master` branch

Follows: #14699
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs linux/ maint Maintenance work -- continuous integration, build scripts, infrastructure resources/

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

chore(linux): Allow to skip API check

4 participants