Add a workflow to regularly run `make linkcheck`
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 2.1k
- 派生
- 1k
- 平均合并
- 2 天 12 小时
- 30 天内合并 PR
- 12
描述
This is a follow-up of #727 and related to #681. Since make linkcheck is somewhat unreliable and can't be required for regular PR, the idea is to use a workflow to run it regularly and create (or update) an issue when a link is unreachable. Note that make linkcheck is already run for PRs, but the result is only visible by looking at the logs.
@AlexWaygood shared a similar workflow in https://github.com/python/devguide/pull/727#issuecomment-1100939982:
Over at typeshed, we have a test that runs every night. If it fails, a bot auto-creates an issue for us. It works pretty well!
Here's the .yml file: https://github.com/python/typeshed/blob/master/.github/workflows/daily.yml
And here's an example of an issue that the bot auto-created when the test failed: https://github.com/python/typeshed/issues/7572
This workflow creates a new issue every time, and it might be ok if it's run weekly/monthly however -- if we want to run it more frequently -- updating an existing issue might be a better approach.
@hugovk also raised a concern in https://github.com/python/devguide/pull/727#issuecomment-1100912440
One concern: if the cron is often failing (which it might, and often), we don't want it to show the repo as failed at the top:
If this sounds useful we can agree on the details, fix the currently broken links, and adapt the workflow linked above.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
检查运行 make linkcheck 的现有 PR 工作流,并将其与所引用的 typeshed 文件 .github/workflows/daily.yml 进行比较。确定计划运行的工作流应创建新的 issue 还是更新现有 issue,并确保报告链接失败,但不要因此导致 repository 的常规 PR 检查失败。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- github-actions, python
- 领域
- ci-cd, documentation
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 28/100