SHA256
forked from course-team/tjhlp-gitea
feat: Issue 模板引导链接改指课程官网, 平台地址改由 public_url 注入
- 两个 config.yaml 的 contact_links 从 example.com 换成真实入口:
官网《学会提问》/ 课程官网 / 平台提问速查, 让答疑平台与官网互相导流
- 模板支持 {{BASE_URL}}/{{ORG}}/{{REPO}} 占位符, 推送时替换,
换学期建新组织不用改模板; 未配置时保留占位符并告警而不是推坏链接
- scripts: 新增 gitea.public_url(对外地址, 与 CLI 用的 url 区分),
utils.web_base_url()/render_template_placeholders() 及单元测试
This commit is contained in:
@@ -17,16 +17,35 @@
|
||||
issue-templates/
|
||||
├── general/ general 仓库使用
|
||||
│ └── .gitea/ISSUE_TEMPLATE/
|
||||
│ ├── config.yaml 禁止空白 Issue + 外部链接
|
||||
│ ├── config.yaml 禁止空白 Issue + 课程官网/提问规范链接
|
||||
│ ├── course-question.yaml 课程内容 / 知识点答疑
|
||||
│ ├── homework-help.yaml 编程作业问题
|
||||
│ └── env-setup.yaml 环境配置问题
|
||||
└── homework/ hwXX 作业仓库使用
|
||||
└── .gitea/ISSUE_TEMPLATE/
|
||||
├── config.yaml 禁止空白 Issue + 引导到 general
|
||||
├── config.yaml 禁止空白 Issue + 引导到 general + 课程官网链接
|
||||
└── homework-help.yaml 编程作业问题(无作业编号字段)
|
||||
```
|
||||
|
||||
## config.yaml 里的链接与占位符
|
||||
|
||||
`config.yaml` 的 `contact_links` 是「新建 Issue」页面上的引导入口, 目前指向**课程官网**
|
||||
(学会提问 / 课程信息 / 常见问题), 把答疑平台和官网串起来。课程官网地址是硬编码常量
|
||||
(`https://cpp.tongji.sh/Website/`), 换域名时两个 `config.yaml` 要一起改。
|
||||
|
||||
平台自身的链接用占位符, 避免把学期组织名写死:
|
||||
|
||||
| 占位符 | 替换为 | 来源 |
|
||||
|--------|--------|------|
|
||||
| `{{BASE_URL}}` | 面向同学的平台地址 | `scripts/settings.toml` 的 `gitea.public_url` |
|
||||
| `{{ORG}}` | 组织名(如 `tjhlp-2025f`) | 推送时的目标仓库 |
|
||||
| `{{REPO}}` | 仓库名(如 `hw01`) | 推送时的目标仓库 |
|
||||
|
||||
> 换学期只要新建组织、重跑 `setup init` / `create-homework`, 模板里的链接会自动跟着走。
|
||||
> `public_url` 没配时会保留占位符并打印警告, 不会推上一条坏链接。
|
||||
> 注意 `gitea.url`(CLI 调 API 用, 带内部端口)与 `public_url`(Apache 反代后的对外地址)
|
||||
> 是两回事, 写进模板的必须是后者。
|
||||
|
||||
## 模板说明
|
||||
|
||||
### general 仓库(3 个模板)
|
||||
@@ -97,10 +116,15 @@ uv run tjhlp repos init-templates tjhlp-2025f/hw01 --type homework
|
||||
|
||||
## 自定义
|
||||
|
||||
如需调整模板内容(如添加新的问题分类、修改引导文案), 直接编辑对应的 YAML 文件, 然后重新推送:
|
||||
如需调整模板内容(如添加新的问题分类、修改引导文案、更新 `config.yaml` 里的链接),
|
||||
直接编辑对应的 YAML 文件, 然后重新推送:
|
||||
|
||||
```bash
|
||||
# 已有仓库原地更新(general 与各 hwNN 都要推一次)
|
||||
uv run tjhlp repos init-templates tjhlp-2025f/general --type general
|
||||
uv run tjhlp repos init-templates tjhlp-2025f/hw01 --type homework
|
||||
```
|
||||
|
||||
推送会覆盖远端同名文件(走 API 的 create-or-update), 不需要重建仓库。
|
||||
|
||||
YAML 模板语法参考 [Gitea 文档](https://docs.gitea.com/usage/issue-pull-request-templates#syntax-for-yaml-template)。
|
||||
|
||||
@@ -1,8 +1,11 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 课程主页
|
||||
url: https://example.com
|
||||
about: 访问课程主页获取有关资源
|
||||
- name: 常见问题汇总
|
||||
url: https://example.com/faq
|
||||
about: 提问前请先查阅常见问题汇总
|
||||
- name: 提问前必读 · 学会提问
|
||||
url: http://10.80.42.185/Website/ask-question/
|
||||
about: 课程官网上的提问规范。不合规范的提问很可能不会得到回答
|
||||
- name: 课程官网
|
||||
url: http://10.80.42.185/Website/
|
||||
about: 课程信息、作业说明、环境配置要求、常见问题
|
||||
- name: 答疑平台提问指南
|
||||
url: "{{BASE_URL}}/assets/tjhlp/ask-guide.html"
|
||||
about: 搜索 Issue、选择模板、填写信息、关闭 Issue 的平台内速查
|
||||
|
||||
@@ -1,5 +1,11 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 一般性问题请到 general 仓库提问
|
||||
url: https://example.com
|
||||
url: "{{BASE_URL}}/{{ORG}}/general/issues/new/choose"
|
||||
about: 课程内容答疑、环境配置等非作业特定问题请到 general 仓库
|
||||
- name: 提问前必读 · 学会提问
|
||||
url: https://cpp.tongji.sh/Website/ask-question/
|
||||
about: 课程官网上的提问规范。不合规范的提问很可能不会得到回答
|
||||
- name: 课程官网
|
||||
url: https://cpp.tongji.sh/Website/
|
||||
about: 课程信息、作业说明、环境配置要求、常见问题
|
||||
|
||||
Reference in New Issue
Block a user