Skip to content

Rename BuildNotes to Comments#2398

Merged
williamjallen merged 1 commit intoKitware:masterfrom
williamjallen:buildnote-refactor
Sep 4, 2024
Merged

Rename BuildNotes to Comments#2398
williamjallen merged 1 commit intoKitware:masterfrom
williamjallen:buildnote-refactor

Conversation

@williamjallen
Copy link
Collaborator

@williamjallen williamjallen commented Aug 28, 2024

CDash confusingly has "notes", which are uploaded by CTest and are often used to upload artifacts, and "build notes", which are comments users leave on a given build via the web UI. While both types of notes are poorly named, build notes are by far the easiest to rename, so the decision has been made to rename them to "comments" to better reflect their true purpose. This PR renames build notes to comments across the codebase, while moving to an Eloquent model and generally modernizing the underlying code. I plan to make a follow-up PR to expose these comments via the GraphQL API and convert the UI to use the new API.

Copy link
Member

@josephsnyder josephsnyder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't find an issue with my quick clicking around in a test environment. LGTM but I'll let you push the merge forward, if we want to wait for Zack to review!

@williamjallen williamjallen added this pull request to the merge queue Sep 4, 2024
Merged via the queue into Kitware:master with commit 10a8270 Sep 4, 2024
@williamjallen williamjallen deleted the buildnote-refactor branch September 4, 2024 13:45
github-merge-queue bot pushed a commit that referenced this pull request Jul 21, 2025
CDash previously had the concept of "build notes" and "user notes" which
was endlessly confusing to both developers and users. #2398 changed most
of the internal references to rename "user notes" to "comments". This PR
continues that effort by changing the UI to reflect the new terminology.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants