Repository navigation
ci: versions are MAJOR.MINOR.PATCH, a new one with every code change (#44) #45
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| #!/bin/sh | ||
| # | ||
| # Copyright (c) OpenIPC https://openipc.org MIT License | ||
| # | ||
| # check-version.sh — fail a pull request that changes the code or the build | ||
| # but not VTESSE_VERSION in include/vtesse/version.h. A new version must be | ||
| # MAJOR.MINOR.PATCH without leading zeros, greater than the base one, and | ||
| # have its section in CHANGELOG.md ("## <version> — YYYY-MM-DD") that the | ||
| # base branch does not have yet. The sources, android/ (except its unit | ||
| # tests), the Makefile, ci/ and scripts/ count as code or build, without the | ||
| # Markdown files in them (server/README.md, android/README.md); docs, | ||
| # tests/, bench/, screenshots and the workflows in .github/ need no new | ||
| # version. The format is checked only when the version changes, so the | ||
| # MAJOR.MM versions up to 1.12 stay valid until the next code change. | ||
| # | ||
| # Usage: .github/check-version.sh [BASE] (default origin/main; CI passes | ||
| # HEAD^1, the base side of the pull request's merge commit) | ||
| # | ||
|
|
||
| set -eu | ||
|
|
||
| base=${1:-origin/main} | ||
| header=include/vtesse/version.h | ||
| code="include netcore cli vtun port server scripts third_party tools android Makefile ci" | ||
|
There was a problem hiding this comment. 1. Ci-only changes force a version bump The code path list includes ci, so changes under ci/ populate changed and require a new VTESSE_VERSION. A pull request that changes only CI files therefore reaches the unchanged-version error even though CI-only changes are exempt from version bumps. Agent Prompt
|
||
|
|
||
| # The one VTESSE_VERSION definition (comments and other text do not count). | ||
| ver() { | ||
| v=$(sed -n 's/^#define VTESSE_VERSION "\([^"]*\)"[[:space:]]*$/\1/p') | ||
| if [ "$(printf '%s\n' "$v" | grep -c .)" -ne 1 ]; then | ||
| echo "::error::$1:$header: expected one VTESSE_VERSION definition," \ | ||
| "found: $(printf '%s' "$v" | tr '\n' ' ')" >&2 | ||
| exit 1 | ||
| fi | ||
| printf '%s\n' "$v" | ||
| } | ||
|
|
||
| new=$(ver HEAD < "$header") | ||
| old=$(git show "$base:$header" | ver "$base") | ||
|
|
||
| # shellcheck disable=SC2086 # $code is a list of paths | ||
| changed=$(git diff --name-only "$base"...HEAD -- $code ':(exclude)android/app/src/test' \ | ||
| ':(exclude,glob)**/*.md') | ||
|
|
||
| if [ "$new" = "$old" ]; then | ||
| if [ -n "$changed" ]; then | ||
| echo "::error::code or build changed, VTESSE_VERSION is still $old:" \ | ||
| "bump PATCH (fix) or MINOR (feature) and add its CHANGELOG.md section" | ||
| echo "$changed" | ||
| exit 1 | ||
| fi | ||
| echo "version $new unchanged, no code or build changes" | ||
| exit 0 | ||
| fi | ||
|
|
||
| if ! echo "$new" | grep -Eq '^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'; then | ||
|
There was a problem hiding this comment. 3. Patch releases cannot upgrade android apps check-version.sh accepts a greater three-part version such as 1.12.1, but Android's versionCode calculation reads only the major and minor components. If a patch bump is merged before the planned Android formula change, the published APK has the same version code as 1.12 and cannot upgrade an existing installation. Agent Prompt
|
||
| echo "::error::VTESSE_VERSION \"$new\" is not MAJOR.MINOR.PATCH" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # A MAJOR.MM version from before MAJOR.MINOR.PATCH is MAJOR.MM.0: 1.12.0 is 1.12. | ||
| case $old in | ||
| *.*.*) oldn=$old ;; | ||
| *) oldn=$old.0 ;; | ||
| esac | ||
| top=$(printf '%s\n%s\n' "$oldn" "$new" | sort -V | tail -n 1) | ||
| if [ "$new" = "$oldn" ] || [ "$top" != "$new" ]; then | ||
| echo "::error::VTESSE_VERSION $new is not greater than $old" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # $new is digits and dots only (checked above): escape the dots, require a date. | ||
| re=$(printf '%s' "$new" | sed 's/\./\\./g') | ||
| if ! grep -Eq "^## $re — [0-9]{4}-[0-9]{2}-[0-9]{2}\$" CHANGELOG.md; then | ||
| echo "::error::CHANGELOG.md has no section \"## $new — YYYY-MM-DD\"" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # The section must come with this pull request, not be one the base | ||
| # branch already has (a version taken from there brings no notes). | ||
| if git show "$base:CHANGELOG.md" 2>/dev/null | grep -Eq "^## $re — "; then | ||
| echo "::error::the section \"## $new\" is already on $base: take a new version" | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "version $old -> $new, CHANGELOG.md section found" | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.