diff --git a/.github/release-notes/v1.0.0.md b/.github/release-notes/v1.0.0.md new file mode 100644 index 0000000..91a22d9 --- /dev/null +++ b/.github/release-notes/v1.0.0.md @@ -0,0 +1,46 @@ +# Home-Vue-Go v1.0.0 + +Home-Vue-Go 的首个正式版本,将 Vue 3 前端与 Go 后端整合为可直接部署的单文件应用。 + +## 主要功能 + +- Vue 3 + Vite 前端,提供主页、登录页和可视化管理后台。 +- Go + Gin API,使用 Ent ORM 与 SQLite 存储站点配置和业务数据。 +- 支持站点、联系方式、轮换文本和站点外观配置管理。 +- 支持图片上传、JWT 登录认证、密码修改和登录历史记录。 +- 支持本地访问统计以及 Umami 自托管、Umami Cloud 数据源。 +- 前端资源嵌入可执行文件,无需单独部署 Web 静态目录。 + +## 单端口部署 + +前端页面、API 和上传文件统一通过一个 HTTP 端口提供服务: + +- 默认访问地址:`http://localhost:1552` +- API 地址:`http://localhost:1552/api` +- 管理后台:`http://localhost:1552/admin` +- 可通过 `PORT` 环境变量修改监听端口。 + +## 下载与运行 + +请根据系统下载对应安装包: + +- `Home-Vue-Go_Windows.zip` +- `Home-Vue-Go_Linux.tar.gz` +- `Home-Vue-Go_macOS.tar.gz` + +解压后直接运行 `Home-Vue-Go`;Windows 运行 `Home-Vue-Go.exe`。Linux 或 macOS 首次运行前可能需要增加执行权限: + +```bash +chmod +x Home-Vue-Go +./Home-Vue-Go +``` + +首次启动会在程序同级目录创建 `data` 数据目录。默认管理员账号为 `admin`,默认密码为 `admin123`,登录后请立即修改密码。 + +## 升级与数据 + +升级前请备份程序同级目录中的 `data` 文件夹。替换可执行文件即可升级,请勿删除原有的数据库和上传文件。 + +## 构建产物 + +本版本通过 GitHub Actions 自动测试并构建 Windows、Linux 和 macOS amd64 安装包。所有安装包均包含 README 和与原仓库一致的 MIT 许可证。 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 424e340..2797845 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -44,14 +44,17 @@ jobs: matrix: include: - name: Windows + platform: Windows goos: windows extension: .exe archive: zip - name: Linux + platform: Linux goos: linux extension: '' archive: tar.gz - name: macOS + platform: macOS goos: darwin extension: '' archive: tar.gz @@ -79,8 +82,8 @@ jobs: CGO_ENABLED: 0 run: | set -euo pipefail - package_name="home-vue-go-${GOOS}-amd64" - binary_name="${package_name}${{ matrix.extension }}" + package_name="Home-Vue-Go_${{ matrix.platform }}" + binary_name="Home-Vue-Go${{ matrix.extension }}" go build -trimpath -buildvcs=false -ldflags="-s -w" -o "${binary_name}" . mkdir package cp "${binary_name}" README.md LICENSE package/ @@ -92,8 +95,8 @@ jobs: - name: Upload package artifact uses: actions/upload-artifact@v4 with: - name: package-${{ matrix.goos }} - path: home-vue-go-${{ matrix.goos }}-amd64.${{ matrix.archive }} + name: Home-Vue-Go_${{ matrix.platform }} + path: Home-Vue-Go_${{ matrix.platform }}.${{ matrix.archive }} if-no-files-found: error release: @@ -104,13 +107,28 @@ jobs: permissions: contents: write steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Select release notes + id: notes + shell: bash + run: | + notes_file=".github/release-notes/${GITHUB_REF_NAME}.md" + if [ -f "${notes_file}" ]; then + echo "path=${notes_file}" >> "${GITHUB_OUTPUT}" + else + echo "path=" >> "${GITHUB_OUTPUT}" + fi - name: Download package artifacts uses: actions/download-artifact@v4 with: - pattern: package-* + pattern: Home-Vue-Go_* path: release merge-multiple: true - name: Publish release uses: softprops/action-gh-release@v2 with: + name: Home-Vue-Go ${{ github.ref_name }} + body_path: ${{ steps.notes.outputs.path }} + generate_release_notes: ${{ steps.notes.outputs.path == '' }} files: release/* diff --git a/README.md b/README.md index d5d585d..73f14fc 100644 --- a/README.md +++ b/README.md @@ -273,11 +273,11 @@ npm run preview 仓库内置 `.github/workflows/build.yml`,在推送到 `main` 或创建 Pull Request 时运行测试和跨平台构建。每次工作流运行都会产生三个可下载的安装包: -- Windows amd64:ZIP -- Linux amd64:TAR.GZ -- macOS amd64:TAR.GZ +- Windows amd64:`Home-Vue-Go_Windows.zip` +- Linux amd64:`Home-Vue-Go_Linux.tar.gz` +- macOS amd64:`Home-Vue-Go_macOS.tar.gz` -在 GitHub Actions 的运行详情页下载 `package-windows`、`package-linux` 或 `package-darwin`。发布版本时推送一个 `v` 开头的标签,工作流会自动创建 GitHub Release 并附加这三个安装包: +在 GitHub Actions 的运行详情页下载对应平台的 `Home-Vue-Go_<平台>` 构建产物。发布版本时推送一个 `v` 开头的标签,工作流会自动创建 GitHub Release、读取对应版本的发行说明并附加这三个安装包: ```bash git tag v1.0.0 @@ -286,4 +286,4 @@ git push github v1.0.0 ### 许可证 -MIT License +本项目沿用原仓库的 [MIT License](./LICENSE),发行包中也会包含完整的 `LICENSE` 文件。原项目版权声明及许可条款予以保留。