Skip to content

Commit

Permalink
doc: 更新开发指南
Browse files Browse the repository at this point in the history
  • Loading branch information
YDX-2147483647 authored and fky2015 committed Jun 7, 2024
1 parent 6a20fff commit 2bfe946
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/release-tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,4 @@ labels: Release
---

- [ ] 提升版本号到最新
- [ ] 上传新的模板到 Overleaf
- [ ] 发布新的 Release
7 changes: 6 additions & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ make doc

## 参考资料

- 本项目 LaTeX3,因此可以参考的手册包括 expl3 的文档。
- 本项目 LaTeX3,因此可以参考的手册包括 [expl3 的文档](https://www.latex-project.org/help/documentation/)
- [fduthesis 项目代码](https://github.com/stone-zeng/fduthesis)有很多最佳实践,可以参考。
- 样式部分,应该参考研究生院和教务部的相关文件和通知。

Expand All @@ -83,6 +83,9 @@ make doc

## 上传 Overleaf 与更新

> [!NOTE]
> Overleaf 链接已利用 [`overleaf.com/docs` API](https://www.overleaf.com/devs) 自动指向最新发布版,不再需要手动更新。
首先运行 `make overleaf` 打包文件。

1. 打开 Overleaf,点击左上角 `New Projects > Upload Projects` ,然后上传 zip 文件。
Expand All @@ -98,3 +101,5 @@ make doc
版本号:参考 [Semantic Versioning 2.0.0 | Semantic Versioning](https://semver.org/)

![Release Workflow](./assets/release_workflow.png)

上周展示了完整工作流,其中大部分已自动化,只需要手动触发。
2 changes: 1 addition & 1 deletion scripts/regression-testing.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Modified by humans

$ErrorActionPreference = "Stop"
$USE_GHPROXY = $true
$USE_GHPROXY = $false

Push-Location (Split-Path -Path $MyInvocation.MyCommand.Path -Parent)
Write-Host (Get-Location)
Expand Down
2 changes: 1 addition & 1 deletion scripts/regression-testing.zsh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
set -e
${USE_GHPROXY:=true}
${USE_GHPROXY:=false}

mypath=`realpath $0`
cd `dirname $mypath`
Expand Down

0 comments on commit 2bfe946

Please sign in to comment.