Skip to content
This repository was archived by the owner on Dec 28, 2025. It is now read-only.

refactor: unify release validation script and add local path support #19

Merged
imbajin merged 6 commits into from
Nov 14, 2025
Merged

refactor: unify release validation script and add local path support #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a04fdb3
chore: update release workflow and .gitignore entries
imbajin Nov 14, 2025
8a8acf8
refactor: unify release validation script and add local path support
imbajin Nov 14, 2025
b9e896c
refactor: revamp release validation script with enhanced checks V2
imbajin Nov 14, 2025
97dc1b5
refactor: enhance release validation for multi-arch and license check…
imbajin Nov 14, 2025
dfd69a7
refactor: improve validation script error context and reporting V4
imbajin Nov 14, 2025
a86370e
fix: add JSON to CATEGORY_X license validation
imbajin Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions .github/workflows/validate-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ on:
release_version:
required: true
description: svn release version
default: '1.5.0'
default: '1.7.0'
gpg_user:
required: true
description: current release manager (gpg username)
default: 'vgalaxies'
default: 'Junzhi Peng'

push:
branches:
Expand Down Expand Up @@ -67,6 +67,9 @@ jobs:
if [[ ${{ matrix.os }} =~ "macos" ]]; then
brew install svn
fi
if [[ ${{ matrix.os }} =~ "ubuntu" ]]; then
sudo apt-get install -y subversion
fi
rm -rf dist/${{ inputs.release_version }}
svn co ${URL_PREFIX}/${{ inputs.release_version }} dist/${{ inputs.release_version }}

Expand Down Expand Up @@ -241,7 +244,7 @@ jobs:
- name: 7. Validate Binary Packages
run: |
cd dist/${{ inputs.release_version }} || exit
CATEGORY_X="\bGPL|\bLGPL|Sleepycat License|BSD-4-Clause|\bBCL\b|JSR-275|Amazon Software License|\bRSAL\b|\bQPL\b|\bSSPL|\bCPOL|\bNPL1|Creative Commons Non-Commercial"
CATEGORY_X="\bGPL|\bLGPL|Sleepycat License|BSD-4-Clause|\bBCL\b|JSR-275|Amazon Software License|\bRSAL\b|\bQPL\b|\bSSPL|\bCPOL|\bNPL1|Creative Commons Non-Commercial|JSON"
Copy link

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

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

Incomplete regex pattern: The pattern ends with |JSON but should be |JSON\.org to match the source script. The backslash and .org are missing, which could result in false positives (matching any occurrence of "JSON" instead of specifically "JSON.org" license references).

Suggested change
CATEGORY_X="\bGPL|\bLGPL|Sleepycat License|BSD-4-Clause|\bBCL\b|JSR-275|Amazon Software License|\bRSAL\b|\bQPL\b|\bSSPL|\bCPOL|\bNPL1|Creative Commons Non-Commercial|JSON"
CATEGORY_X="\bGPL|\bLGPL|Sleepycat License|BSD-4-Clause|\bBCL\b|JSR-275|Amazon Software License|\bRSAL\b|\bQPL\b|\bSSPL|\bCPOL|\bNPL1|Creative Commons Non-Commercial|JSON\.org"

Copilot uses AI. Check for mistakes.
for i in *.tar.gz; do
if [[ "$i" == *-src.tar.gz ]]; then
# skip source packages
Expand Down Expand Up @@ -347,5 +350,5 @@ jobs:
matrix:
# disable java8 because of server
java_version: ['11']
# TODO: support windows-latest or other OS in future
os: [ubuntu-latest, macos-latest]
# Support multiple OS and architectures (x64 and arm64)
os: [ubuntu-latest, ubuntu-24.04-arm, macos-latest, macos-14]
Copy link

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

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

The matrix configuration adds ARM architecture support (ubuntu-24.04-arm, macos-14) but there's no verification that these runners are available or that the validation script works correctly on ARM architectures. The comment mentions "Support multiple OS and architectures" but:

  1. ubuntu-24.04-arm may not be a valid GitHub-hosted runner (GitHub typically uses ubuntu-latest for both x64 and ARM)
  2. macos-14 is an M1/ARM Mac, which is good, but the combination should be tested

Consider verifying these runner labels are correct and available in your GitHub environment.

Suggested change
os: [ubuntu-latest, ubuntu-24.04-arm, macos-latest, macos-14]
os: [ubuntu-latest, ubuntu-24.04, macos-latest, macos-14]

Copilot uses AI. Check for mistakes.
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,4 @@ GEMINI.md
.vscode/settings.json
.aider*
.gemini/
WARP.md
4 changes: 2 additions & 2 deletions content/cn/docs/contribution-guidelines/validate-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ PMC 同学请特别注意认真检查 `LICENSE` + `NOTICE` 文件，确保文件
# 请优先使用/切换到 `java 11` 版本进行后序的编译和运行操作 (注:`Computer` 仅支持 `java >= 11`)
# java --version

# 尝试在 Unix 环境下编译测试是否正常 (stage 表示从 stage 仓库拉取依赖)
mvn clean package -P stage -Dmaven.test.skip=true -Dcheckstyle.skip=true
# 尝试在 Unix 环境下编译测试是否正常
Copy link

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

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

Same documentation inconsistency as the English version: The command includes -P stage but the comment changed from explicitly mentioning stage repository to a generic compilation comment. The -P stage flag appears at the end now, which is better, but the purpose should still be documented.

Suggested change
# 尝试在 Unix 环境下编译测试是否正常
# 尝试在 Unix 环境下编译测试是否正常，注意使用 `-P stage` 以便使用 stage 仓库进行编译

Copilot uses AI. Check for mistakes.
mvn clean package -DskipTests -Dcheckstyle.skip=true -P stage
```

##### B. 二进制包
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/contribution-guidelines/validate-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ After decompressing `*hugegraph*src.tar.gz`, Do the following checks:
# prefer to use/switch to `java 11` for the following operations (compiling/running) (Note: `Computer` only supports `java >= 11`)
# java --version

# try to compile in the Unix env to check if it works well
mvn clean package -P stage -Dmaven.test.skip=true -Dcheckstyle.skip=true
# try to compile in the Unix env to check if it works well (-P is optional)
Copy link

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

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

Documentation improvement: The comment change mentions "(-P is optional)" but the -P stage flag is still included in the example command. This could be confusing.

Consider either:

  1. Moving -P stage to the end and noting it's optional: mvn clean package -DskipTests -Dcheckstyle.skip=true [-P stage]
  2. Showing two examples: one with and one without the -P stage flag
  3. Removing the optional note if -P stage is actually required for validation

The same issue exists in the Chinese documentation at line 129.

Suggested change
# try to compile in the Unix env to check if it works well (-P is optional)
# try to compile in the Unix env to check if it works well (-P is optional)
mvn clean package -DskipTests -Dcheckstyle.skip=true
# or, if you want to use the 'stage' profile:

Copilot uses AI. Check for mistakes.
mvn clean package -P stage -DskipTests -Dcheckstyle.skip=true
```

##### B. binary package
Expand Down
Loading