Publication Type

Conference Proceeding Article

Version

publishedVersion

Publication Date

10-2023

Abstract

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.

Keywords

code elements, outdated documentation, outdated references, software repositories, workflow automation

Discipline

Software Engineering

Research Areas

Software and Cyber-Physical Systems

Publication

Proceedings of the 39th International Conference on Software Maintenance and Evolution, Bogotá, Colombia, 2023 October 1-6

First Page

553

Last Page

557

ISBN

9798350327830

Identifier

10.1109/ICSME58846.2023.00071

Publisher

IEEE

City or Country

Los Alamitos, CA

Additional URL

https://doi.org/10.1109/ICSME58846.2023.00071

Download

Share

COinS