DeepRelease: Language-agnostic Release Notes Generation from Pull Requests of Open-source Software

Jiang, Huaxi; Zhu, Jie; Li, Yang; Li, Geng; Zuo, Chun

doi:10.1109/apsec53868.2021.00018

Cited by 9 publications

(3 citation statements)

References 20 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…Nath et al [118] propose to generate RNs from commit messages and pull requests using text summarization and word embedding techniques. Jiang et al [111] propose a language-agnostic approach to produce RNs from pull request text using deep learning.…”

Section: Automating Release Note Productionmentioning

confidence: 99%

Demystifying Software Release Note Issues on GitHub

Wu¹,

He²,

Xiao³

et al. 2022

Preprint

View full text Add to dashboard Cite

Release notes (RNs) summarize main changes between two consecutive software versions and serve as a central source of information when users upgrade software. While producing high quality RNs can be hard and poses a variety of challenges to developers, a comprehensive empirical understanding of these challenges is still lacking. In this paper, we bridge this knowledge gap by manually analyzing 1,731 latest GitHub issues to build a comprehensive taxonomy of RN issues with four dimensions: Content, Presentation, Accessibility, and Production. Among these issues, nearly half (48.47%) of them focus on Production; Content, Accessibility, and Presentation take 25.61%, 17.65%, and 8.27%, respectively. We find that: 1) RN producers are more likely to miss information than to include incorrect information, especially for breaking changes; 2) improper layout may bury important information and confuse users; 3) many users find RNs inaccessible due to link deterioration, lack of notification, and obfuscate RN locations; 4) automating and regulating RN production remains challenging despite the great needs of RN producers. Our taxonomy not only pictures a roadmap to improve RN production in practice but also reveals interesting future research directions for automating RN production. CCS CONCEPTS• Software and its engineering → Documentation.

show abstract

Section: Automating Release Note Productionmentioning

confidence: 99%

Demystifying Software Release Note Issues on GitHub

Wu¹,

He²,

Xiao³

et al. 2022

Preprint

View full text Add to dashboard Cite

show abstract

“…To answer RQ. 3, we first explored Pull Requests (PRs) discussions since it is a common mechanism used by developers to discuss new features and improvements in their systems (Soares et al 2015, Gousios et al 2014, Gousios et al 2015, Jiang et al 2021. To perform this analysis, we manually classified 1,533 PRs from 3 OSSs within the Spring Ecosystem 1 .…”

Section: Rq 3 How Do Developers Discuss and Address Nfrs Within Theirmentioning

confidence: 99%

“…Pull Requests (PRs) are a common resource employed by developers for discussing the need for new system features and software maintenance and evolution (Soares et al 2015, Gousios et al 2014, Gousios et al 2015, Jiang et al 2021. A recent study (Jiang et al 2021) on 900 GitHub projects reveals that more than 54% of projects produce their release notes with PRs (e.g., details of recent changes). Given the nature of PR discussions, their content can be a valuable source of information on NFRs.…”

Section: Chapter 5 Understanding How Developers Deal With Non-functio...mentioning

confidence: 99%

Unveiling Design Problems Identification: Combining Multiple Symptoms

JOSE SILVA DE OLIVEIRA

View full text Add to dashboard Cite

I would like to begin by expressing my deep gratitude and appreciation to my parents, who made everything I have achieved possible. I am profoundly thankful to my mother, Ioneide Oliveira, and my father, Antonio Oliveira, who have always supported my decisions. Both are my greatest inspirations and provide me with the motivation I need. I also want to thank my sister, Leilane Oliveira, who has always offered advice and support when needed.I am deeply grateful to my advisor, Alessandro Garcia, who not only guided me but also became a friend. I appreciate all the advice and suggestions he provided. I am certain that during this period of work and friendship, I have grown not only as a researcher but also as a person. I thank my co-advisor, Juliana Alves Pereira, who supported and guided me throughout my thesis. Her expertise helped enrich the quality of this thesis.I would like to thank my girlfriend, Mariana Borges, for all her support during this period. She has always been extremely important for me to stay motivated through all the advice and affection that she always gave to me. I also thank her family, Ideraldo José and Maria Aparecida, who have become my own family.I want to express my gratitude to Leonardo Sousa, Diego Cedrim, and Willian Oizumi, who has been with me since my MSc and have become great friends. They had always provided valuable advice and suggestions, some of which I admit I didn't want to hear but needed to. They all helped me both technically and personally. These are people I will carry with me throughout my life. I would like to thank João Lucas, Caio Barbosa, and Daniel Coutinho, who were always willing to help with research, often pointing out improvements that I couldn't see at times. I am thankful to all the current and former members of the Opus research group who were essential for the development of this thesis.

show abstract

Practitioners' expectations on automated release note generation techniques

Sumana Nath,

Roy

2024

J Software Evolu Process

View full text Add to dashboard Cite

The software development life cycle relies heavily on the software release note, a crucial document. Various practitioners, including project managers and clients, benefit from release notes as they provide an overview of the latest software release. However, the manual generation of release notes is a time‐consuming and stressful task. Researchers have recently proposed automated techniques to generate release notes, saving developers' time and enhancing their understanding of software projects. Unfortunately, the adoption of these tools in practice remains limited. To address this gap, we have taken steps to understand the expectations and requirements of practitioners regarding release note generation techniques before implementing new automated approaches. Consequently, our approach involves two main stages: First, we conduct a comprehensive review of the relevant literature and analyze existing release notes from GitHub repositories to gain insights into the current practices. Second, we conduct an online survey study to gather input from practitioners and understand their expectations regarding release notes. We have reviewed 16 papers related to release notes and explored 3347 release notes from 21 GitHub repositories. Our analysis revealed key artifacts present in release note contents, including issues (29%), pull requests (32%), commits (19%), and common vulnerabilities and exposures (CVE) issues (6%). Additionally, we conducted a survey study involving 32 professionals to understand the essential information that should be included in release notes based on users' roles. For instance, project managers were more interested in learning about new features rather than less critical bug fixes. Furthermore, we identified gaps in existing systems and essential factors to consider when implementing release notes techniques in software engineering. The insights gained from our study can guide future research directions and assist practitioners in generating release notes with relevant content, thus improving the overall quality of documentation in software development.

show abstract

DeepRelease: Language-agnostic Release Notes Generation from Pull Requests of Open-source Software

Cited by 9 publications

References 20 publications

Demystifying Software Release Note Issues on GitHub

Demystifying Software Release Note Issues on GitHub

Unveiling Design Problems Identification: Combining Multiple Symptoms

Practitioners' expectations on automated release note generation techniques

Contact Info

Product

Resources

About