Encountering outdated documentation is not a rare occurrence for developers and users in the software engineering community. To ensure that software documentation is up-to-date, developers often have to manually check whether the documentation needs to be updated whenever changes are made to the source code. In our previous work, we proposed an approach to automatically detect outdated code element references in software repositories and found that more than a quarter of the 1000 most popular projects on GitHub contained at least one outdated reference. In this paper, we present a GitHub Actions tool that builds on our previous work's approach that GitHub developers can configure to automatically scan for outdated code element references in their GitHub project's documentation whenever a pull request is submitted.
翻译:在软件工程社区中,开发者与用户遭遇过期文档并非罕见现象。为确保软件文档的时效性,开发者在修改源代码后,通常需要手动检查文档是否需同步更新。在先前工作中,我们提出了一种自动检测软件仓库中过期代码元素引用的方法,并发现GitHub上最受欢迎的1000个项目中,超过四分之一存在至少一处过期引用。本文提出一个基于先前方法的GitHub Actions工具,开发者可配置该工具,在每次提交拉取请求时自动扫描其GitHub项目文档中的过期代码元素引用。