chore(core): Add additional API checks 🎬 #9867
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ermshiperete
requested review from
mcdurdin,
jahorton,
darcywong00 and
rc-swag
as code owners
User Test ResultsTest specification and instructions User tests are not required |
github-actions
bot
added
linux/
common/
common/resources/
ermshiperete
force-pushed
the
chore/linux/9801_coreversion
branch
from
ff88242 to
7f166a6
Compare
This change adds additional checks for the symbols file: - if a line with a method name gets changed, the package version number in that line also needs to be updated - for major API changes (methods renamed or removed) the API version numbers needs to be incremented - the API version numbers in the .symbols file and in `CORE_API_VERSION.md` need to match
ermshiperete
force-pushed
the
chore/linux/9801_coreversion
branch
from
7f166a6 to
30250e3
Compare
mcdurdin
requested changes
Oct 27, 2023
ermshiperete
changed the base branch from
refactor/linux/packagingScript
to
chore/linux/9801_apiversion
ermshiperete
changed the title
|
I split out the Core API version change into #9877. |
mcdurdin
reviewed
Nov 1, 2023
linux/scripts/deb-packaging.sh
Outdated
Comment on lines
22
to
23
| "--git-ref=GIT_REF The ref of the HEAD commit, e.g. HEAD of the PR branch (for verify action)" \ | ||
| "--git-base=GIT_BASE The ref of the base commit, e.g. HEAD of the master branch (for verify action)" |
There was a problem hiding this comment.
Should these be SHAs or commitishes/refs, tag names, branch names or what? 😁
There was a problem hiding this comment.
Suggested change
| "--git-ref=GIT_REF The ref of the HEAD commit, e.g. HEAD of the PR branch (for verify action)" \ | |
| "--git-base=GIT_BASE The ref of the base commit, e.g. HEAD of the master branch (for verify action)" | |
| "--git-ref=GIT_REF The SHA of the HEAD commit, e.g. of the PR branch (for verify action)" \ | |
| "--git-base=GIT_BASE The ref of the base commit, usually the name of the base branch, e.g. master, stable-16.0 (for verify action)" |
| cd "${REPO_ROOT}/linux" | ||
| } | ||
|
|
||
| is_symbols_file_changed() { |
There was a problem hiding this comment.
Suggested change
| is_symbols_file_changed() { | |
| # | |
| # Compare the SHA of the base and head commits for changes to the .symbols file | |
| # | |
| is_symbols_file_changed() { |
|
|
||
| check_api_not_changed() { | ||
| # Checks that the API did not change compared to what's documented in the .symbols file | ||
| tmpDir=$(mktemp -d) |
linux/scripts/deb-packaging.sh
Outdated
| # .symbols file changed, now check if the package version got updated as well | ||
| # Note: We don't check that ALL changes in that file have an updated package version - | ||
| # we hope this gets flagged in code review. | ||
| if ! git log -p -1 -- "debian/${PKG_NAME}.symbols" | grep -q "${PKG_VERSION}"; then |
There was a problem hiding this comment.
${PKG_VERSION} could just be ${VERSION} I think? And then we can eliminate all of that from this script?
Comment on lines
+103
to
+105
| # .symbols file changed, now check if the package version got updated as well | ||
| # Note: We don't check that ALL changes in that file have an updated package version - | ||
| # we hope this gets flagged in code review. |
There was a problem hiding this comment.
Suggested change
| # .symbols file changed, now check if the package version got updated as well | |
| # Note: We don't check that ALL changes in that file have an updated package version - | |
| # we hope this gets flagged in code review. | |
| # .symbols file changed, now check if the package version got updated as well | |
| # Note: We don't check that ALL changes in that file have an updated package version - | |
| # we hope this gets flagged in code review. | |
| # Note: This version number check may not match the actual released version, if the branch | |
| # is out of date when it is merged to the release branch (master/beta/stable-x.y). If this | |
| # is considered important, then make sure the branch is up to date, and wait for test | |
| # builds to complete, before merging. |
linux/scripts/deb-packaging.sh
Outdated
| get_api_version_in_symbols_file() { | ||
| # Extract 1 from "libkeymancore.so.1 libkeymancore #MINVER#" | ||
| local firstline | ||
| firstline=$(head -1 "debian/${PKG_NAME}.symbols") |
There was a problem hiding this comment.
Suggested change
| firstline=$(head -1 "debian/${PKG_NAME}.symbols") | |
| firstline="$(head -1 "debian/${PKG_NAME}.symbols")" |
mcdurdin
approved these changes
Nov 13, 2023
linux/scripts/deb-packaging.sh
Outdated
Comment on lines
139
to
143
| git checkout "${GIT_SHA}" -- "debian/${PKG_NAME}.symbols" | ||
| NEW_VERSION=$(get_api_version_in_symbols_file) | ||
| git checkout "${GIT_BASE}" -- "debian/${PKG_NAME}.symbols" | ||
| OLD_VERSION=$(get_api_version_in_symbols_file) | ||
| git checkout "${GIT_SHA}" -- "debian/${PKG_NAME}.symbols" |
There was a problem hiding this comment.
We could reduce the number of checkouts by switching order of operations here, but it's not terribly important.
Addresses code review comment.
|
Changes in this pull request will be available for download in Keyman version 17.0.210-alpha |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
numbers needs to be incremented
CORE_API_VERSION.mdneed to matchCloses #9801
@keymanapp-test-bot skip