feat: Version 2.0.0 - 重构、CI/CD 和增强功能

.gitattributes

@@ -1 +1,10 @@
+# 统一使用 LF 换行符
+* text=auto eol=lf
+
+# Windows 特定文件保持 CRLF
+*.bat text eol=crlf
+*.cmd text eol=crlf
+*.ps1 text eol=crlf
+
+# LFS for large files
 dist/* filter=lfs diff=lfs merge=lfs -text

.github/workflows/release.yml

@@ -0,0 +1,142 @@
+# -*- coding: utf-8 -*-
+name: Build and Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        architecture: [x64]
+        python-version: ['3.11']
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests
+        run: |
+          pytest -v --cov=remark --cov-report=term-missing
+
+      - name: Install PyInstaller
+        run: |
+          pip install pyinstaller
+
+      - name: Build executable
+        run: |
+          pyinstaller remark.spec --clean
+
+      - name: Rename executable with version
+        run: |
+          if ($env:GITHUB_REF -match "refs/tags/v(.*)") {
+            $version = $matches[1]
+          } else {
+            $version = "dev"
+          }
+          Copy-Item "dist\windows-folder-remark.exe" "dist\windows-folder-remark-$version.exe"
+
+      - name: Generate checksum
+        run: |
+          if ($env:GITHUB_REF -match "refs/tags/v(.*)") {
+            $version = $matches[1]
+          } else {
+            $version = "dev"
+          }
+          $file = "dist\windows-folder-remark-$version.exe"
+          certutil -hashfile $file SHA256 > "$file.sha256"
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: windows-folder-remark-${{ matrix.architecture }}
+          path: |
+            dist/*.exe
+            dist/*.sha256
+
+  release:
+    needs: build
+    runs-on: windows-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: artifacts
+
+      - name: Extract version from tag
+        id: version
+        run: |
+          if ($env:GITHUB_REF -match "refs/tags/v(.*)") {
+            $version = $matches[1]
+            echo "version=$version" >> $env:GITHUB_OUTPUT
+            echo "version=$version"
+          }
+
+      - name: Generate Release Notes
+        id: release_notes
+        run: |
+          $notes = @"
+          ## windows-folder-remark v${{ steps.version.outputs.version }}
+
+          ### 下载
+          - `windows-folder-remark-${{ steps.version.outputs.version }}.exe`: 单文件可执行程序，无需安装 Python
+          - `.sha256` 文件用于验证下载文件的完整性
+
+          ### 使用方法
+          ```powershell
+          # 添加备注
+          .\windows-folder-remark-${{ steps.version.outputs.version }}.exe "C:\MyFolder" "我的备注"
+
+          # 查看备注
+          .\windows-folder-remark-${{ steps.version.outputs.version }}.exe --view "C:\MyFolder"
+
+          # 删除备注
+          .\windows-folder-remark-${{ steps.version.outputs.version }}.exe --delete "C:\MyFolder"
+
+          # 交互模式
+          .\windows-folder-remark-${{ steps.version.outputs.version }}.exe
+          ```
+
+          ### 验证下载
+          ```powershell
+          certutil -hashfile windows-folder-remark-${{ steps.version.outputs.version }}.exe SHA256
+          ```
+          然后对比生成的哈希值与 .sha256 文件中的值是否一致。
+
+          ### 系统要求
+          - Windows 7 或更高版本
+          "@
+          $notes | Out-File -Encoding UTF8 -FilePath release_notes.txt
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: windows-folder-remark v${{ steps.version.outputs.version }}
+          body_path: release_notes.txt
+          draft: false
+          prerelease: false
+          files: |
+            artifacts/**/*.exe
+            artifacts/**/*.sha256
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,69 @@
+name: Test and Build
+
+on:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest -v --cov=remark --cov-report=term-missing
+
+  build-verify:
+    runs-on: windows-latest
+    needs: test
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Install PyInstaller
+        run: pip install pyinstaller
+
+      - name: Build executable
+        run: pyinstaller remark.spec --clean
+
+      - name: Verify executable
+        run: |
+          $exePath = "dist\windows-folder-remark.exe"
+          if (-not (Test-Path $exePath)) {
+            Write-Error "Executable not found!"
+            exit 1
+          }
+          & $exePath --help
+          if ($LASTEXITCODE -ne 0) {
+            Write-Error "Executable failed to run!"
+            exit 1
+          }
+          Write-Output "Build successful!"
+        shell: pwsh

.gitignore

@@ -1,3 +1,34 @@
+# IDE
 .idea
-*.spec
-build
+
+# Build
+build/
+dist/
+# PyInstaller spec files (keep remark.spec)
+# *.spec
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+.eggs/
+.venv/
+venv/
+*.egg
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+*.cover
+
+# Type checking
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.ruff_cache/
+
+# Distribution
+*.whl
+*.tar.gz

.pre-commit-config.yaml

@@ -0,0 +1,68 @@
+# Pre-commit configuration
+# https://pre-commit.com/
+
+default_language_version:
+  python: python3.9
+
+default_stages: [pre-commit]
+
+repos:
+  # Ruff - 代码检查和格式化
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  # Pre-commit hooks for general checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace     # 删除行尾空格
+      - id: end-of-file-fixer       # 文件末尾添加换行
+      - id: check-yaml              # 检查 YAML 语法
+      - id: check-toml              # 检查 TOML 语法
+      - id: check-added-large-files # 防止大文件提交
+        args: ['--maxkb=1000']
+      - id: check-merge-conflict    # 检查合并冲突标记
+      - id: check-case-conflict     # 检查大小写冲突
+      - id: check-docstring-first   # 检查 docstring 是否在代码前
+
+  # Mypy - 静态类型检查
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.14.1
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - types-setuptools
+        exclude: ^remark\.py$
+
+  # Local hooks - pre-push 阶段（测试 + 构建）
+  - repo: local
+    hooks:
+      - id: run-tests
+        name: Run tests
+        entry: pytest -v -m "not slow" --cov=remark --cov-report=term-missing
+        language: system
+        stages: [pre-push]
+        pass_filenames: false
+
+      - id: build-exe
+        name: Build exe (Windows only)
+        entry: bash -c 'if [[ "$OSTYPE" == "msys" || "$OSTYPE" == "win32" ]]; then pyinstaller remark.spec --clean; else echo "Skip build on non-Windows"; fi'
+        language: system
+        stages: [pre-push]
+        pass_filenames: false
+
+# 全局排除
+exclude: |
+  ^(?:
+      \.venv/|
+      \.git/|
+      \.mypy_cache/|
+      __pycache__/|
+      build/|
+      dist/|
+      *.egg-info/
+    )

.python-version

@@ -0,0 +1 @@
+3.11.7

CHANGELOG.md

@@ -0,0 +1,62 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- GitHub Actions CI/CD for automated releases
+- PyInstaller configuration for Windows executable builds
+- Version management script for release automation
+- Support for both 32-bit and 64-bit Windows builds
+
+## [2.0.0] - Unreleased
+
+### Added
+- UTF-16 encoding detection and conversion for desktop.ini
+- User confirmation prompt before encoding conversion
+- EncodingConversionCanceled exception for safer error handling
+- Smart delete logic: removes InfoTip while preserving other desktop.ini settings
+- Top-level exception handling in CLI main()
+- Windows platform check before running
+
+### Changed
+- Improved desktop.ini read/write operations with encoding safety
+- Better error handling with exception-based flow control
+- Enhanced folder comment handling with dedicated storage layer
+- Refactored command-line argument parsing with argparse
+
+### Fixed
+- Fixed desktop.ini encoding issues
+- Path handling with spaces using os.path.join()
+- Exception handling for encoding conversion
+
+### Removed
+- File comment functionality (COM component and Property Store)
+- notify_shell_update function (no longer needed)
+- File-related imports and handlers
+
+## [1.0] - 2022-05-03
+
+### Added
+- Interactive mode with continuous loop for batch processing
+- Help system with usage instructions
+- Comment length validation
+- Complete exception handling mechanism
+
+### Fixed
+- Path with spaces handling issue
+- Command injection vulnerability (subprocess replaced os.system)
+- Encoding conversion exception handling
+- Explicit file write encoding specification
+
+### Changed
+- Improved help messages and usage prompts
+- Packaged as Windows executable
+
+[Unreleased]: https://github.com/piratf/windows-folder-remark/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/piratf/windows-folder-remark/compare/v1.0...v2.0.0
+[1.0]: https://github.com/piratf/windows-folder-remark/releases/tag/v1.0