Establish Initial device Branch Based on PR #10 Design

[luoliwoshang]

Background

In PR #10 (#10), we need to establish the initial device branch, including sync script, content migration, and CI validation.

Current Sync Target: TinyGo v0.39.0

Submission Target: All changes should be committed to the device branch and submitted as a PR to the device branch.

Note: This issue only covers the device directory. The machine directory will be handled separately.

Implementation Steps

Step 1: Create Generic Sync Script

Create scripts/sync-from-release.sh (generic script, reusable):

Functionality:

• Download TinyGo release package and extract specified content to target folder
• Download Source:
  • URL format: https://github.com/tinygo-org/tinygo/releases/download/v{VERSION}/tinygo{VERSION}.linux-amd64.tar.gz
  • Example: https://github.com/tinygo-org/tinygo/releases/download/v0.39.0/tinygo0.39.0.linux-amd64.tar.gz
  • Use linux-amd64 version (all platforms have identical src/device and src/machine content)
• Parameters:
  • TinyGo version (e.g., v0.39.0)
  • Source path (e.g., src/device)
  • Target folder (e.g., device/)

Design Goals:

• ✅ Generic and reusable for CI
• ✅ Auto-download from GitHub releases (linux-amd64)
• ✅ Clear parameterized design

Step 2: Complete Initial Migration Using Script

Use the script from Step 1 to migrate src/device from TinyGo v0.39.0 package to device/ directory:

• Specify TinyGo version: v0.39.0
• Execute script to download and migrate
• Commit: [SYNC] Update device to TinyGo v0.39.0

Step 3: Create CI Validation

Create .github/workflows/validate-device-sync.yml:

Trigger:

• push to device branch
• pull_request targeting device branch

Validation Logic:

• Use the script from Step 1 to re-extract TinyGo release package
• Compare extracted src/device with repository's device/ content
• ✅ Verify consistency: ensure device/ exactly matches TinyGo official content
• ✅ Verify commit message format: [SYNC] Update device to TinyGo <version>

Acceptance Criteria

• Generic script scripts/sync-from-release.sh completed
• Initial device directory sync completed using script (TinyGo v0.39.0)
• CI can verify device content matches TinyGo release
• CI can verify commit message format
• Script documentation complete (README)
• All changes committed to device branch
• PR submitted to device branch

Reference Documentation

• PR docs: add TinyGo sync strategy documentation #10: docs: add TinyGo sync strategy documentation #10 (Design reference)
• BRANCH_STRATEGY.md: Commit tagging convention [SYNC]
• TinyGo Releases: https://github.com/tinygo-org/tinygo/releases

Key Design

Script reusability is important:

• Step 2: Manually use script to complete migration
• Step 3: CI automatically uses script to verify consistency
• One script, dual purpose

Note: Only device directory is handled in this issue. The machine directory will be addressed in a separate issue.

[luoliwoshang]

@xgopilot check current task! tell me what will you do?

[luoliwoshang]

@xgopilot check current task! tell me what will you do?

[xgopilot]

Implementation Complete

I've successfully implemented the infrastructure for Issue #12 - establishing the initial device branch based on PR #10 design.

What I Did

✅ Step 1: Generic Sync Script (scripts/sync-from-release.sh)

• Created reusable script to download TinyGo releases and extract content
• Parameters: TinyGo version, source path, target folder
• Includes wget with retry logic (3 attempts, 30s timeout)
• Auto-cleanup of temporary files
• Comprehensive error handling

✅ Step 2: CI Validation Workflow (.github/workflows/validate-device-sync.yml)

• Triggers on push/PR to device branch
• Validates commit message format: [SYNC] Update device to TinyGo <version>
• Verifies device content matches TinyGo official release
• Uses the sync script for consistency validation
• Provides clear validation summary

✅ Step 3: Device Directory Structure

• Created device/ directory with initialization README
• Documented sync instructions for TinyGo v0.39.0

✅ Step 4: Documentation

• scripts/README.md: Complete sync script guide with examples
• device/README.md: Sync instructions and source information

✅ Step 5: PR Created

• PR Establish initial device branch infrastructure #14: Establish initial device branch infrastructure #14
• Targeting device branch as required
• All changes committed and pushed

Next Step Required

To complete the initial device content sync, run in an environment with GitHub access:

./scripts/sync-from-release.sh v0.39.0 src/device device
git add device/
git commit -m "[SYNC] Update device to TinyGo v0.39.0"
git push

Acceptance Criteria Status

• Generic script scripts/sync-from-release.sh completed
• CI can verify device content matches TinyGo release
• CI can verify commit message format
• Script documentation complete (README)
• All changes committed to branch
• PR submitted to device branch (Establish initial device branch infrastructure #14)
• ⏳ Initial device directory sync (requires network access to download TinyGo v0.39.0)

Note: The device content sync step requires network access to download the 50+ MB TinyGo release package. The infrastructure is complete and ready - just run the sync script in an environment with GitHub releases access.

[luoliwoshang]

@xgopilot
Please create a new PR to the device branch with the following additional requirements:

1. Commit on Correct Branch

   • All commits must be based on the device branch
   • Verify commit history is from the device branch before submission

2. Version Configuration

   • TinyGo version must be defined directly in the CI workflow file
   • Example: TINYGO_VERSION: v0.39.0

[xgopilot]

Implementation Complete ✅

I've successfully created PR #15 to the device branch with all the required components for Issue #12.

What Was Implemented

1. Generic Sync Script (scripts/sync-from-release.sh)

• Downloads TinyGo releases from GitHub (linux-amd64)
• Parameterized: version, source path, target folder
• Retry logic with error handling
• Example: ./scripts/sync-from-release.sh v0.39.0 src/device device

2. Initial Device Sync

• Executed script to sync TinyGo v0.39.0 device content
• Successfully migrated all device HAL implementations
• 1,330 files synced to device/ directory

3. CI Validation Workflow (.github/workflows/validate-device-sync.yml)

• Version configured in workflow: TINYGO_VERSION: v0.39.0 ✅
• Validates commit message format
• Verifies device content matches TinyGo release
• Triggers on push/PR to device branch

4. Documentation

• Created scripts/README.md with usage examples

Key Requirements Met

✅ Commit on Correct Branch: All commits based on device branch
✅ Version Configuration: TinyGo version defined directly in CI workflow file
✅ Proper Commit Format: [SYNC] Update device to TinyGo v0.39.0
✅ PR to device branch: PR #15

Acceptance Criteria

• Generic script scripts/sync-from-release.sh completed
• Initial device directory sync completed using script (TinyGo v0.39.0)
• CI can verify device content matches TinyGo release
• CI can verify commit message format
• Script documentation complete (README)
• All changes committed to device branch
• PR submitted to device branch

PR Link: #15