Skip to content

11376 add version note to diff summary #11390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ofahimIQSS merged 5 commits into from
Apr 9, 2025
Merged

11376 add version note to diff summary #11390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
30d0123
#11376 add version note to the difference summary
sekmiller Apr 1, 2025
26c74a7
#11376 add version note to diff ui/api
sekmiller Apr 2, 2025
59f6a6b
#11376 only show version note if enabled
sekmiller Apr 2, 2025
210ba24
Merge branch 'develop' into 11376-add-version-note-to-diff-summary
sekmiller Apr 3, 2025
ec14707
Merge branch 'develop' into 11376-add-version-note-to-diff-summary
sekmiller Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/main/java/edu/harvard/iq/dataverse/DatasetVersionDifference.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1782,11 +1782,13 @@ public JsonObjectBuilder compareVersionsAsJson() {
JsonObjectBuilder jobVersion = new NullSafeJsonBuilder();
jobVersion.add("versionNumber", originalVersion.getFriendlyVersionNumber());
jobVersion.add("versionState", originalVersion.getVersionState().name());
jobVersion.add("versionNote", originalVersion.getVersionNote());
Copy link
Copy Markdown
Contributor

@stevenwinship stevenwinship Apr 8, 2025

Choose a reason for hiding this comment

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

Looks like versionNote can be null. Surround with if != null to prevent the field from being added when null.

Copy link
Copy Markdown
Contributor

@stevenwinship stevenwinship Apr 8, 2025

Choose a reason for hiding this comment

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

never mind I didn't see the NullSafeJsonBuilder

jobVersion.add("lastUpdatedDate", new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(originalVersion.getLastUpdateTime()));
job.add("oldVersion", jobVersion);
jobVersion = new NullSafeJsonBuilder();
jobVersion.add("versionNumber", newVersion.getFriendlyVersionNumber());
jobVersion.add("versionState", newVersion.getVersionState().name());
jobVersion.add("versionNote", newVersion.getVersionNote());
jobVersion.add("lastUpdatedDate", new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(newVersion.getLastUpdateTime()));
job.add("newVersion", jobVersion);

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/edu/harvard/iq/dataverse/api/Datasets.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3009,7 +3009,7 @@ public Response getCompareVersionsSummary(@Context ContainerRequestContext crc,
} else {
versionBuilder.add("summary", dvdiff.getSummaryDifferenceAsJson());
}

versionBuilder.add("versionNote", dv.getVersionNote());
versionBuilder.add("contributors", datasetversionService.getContributorsNames(dv));
versionBuilder.add("publishedOn", !dv.isDraft() ? dv.getPublicationDateAsString() : "");
differenceSummaries.add(versionBuilder);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/propertyFiles/Bundle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2169,6 +2169,7 @@ file.viewDiffDialog.dialog.warning=Please select two versions to view the differ
file.viewDiffDialog.notAvailable=N/A
file.viewDiffDialog.version=Version
file.viewDiffDialog.lastUpdated=Last Updated
file.viewDiffDialog.versionNote=Version Note
file.viewDiffDialog.fileID=File ID
file.viewDiffDialog.fileName=Name
file.viewDiffDialog.fileType=Type
Expand Down
6 changes: 4 additions & 2 deletions src/main/webapp/dataset.xhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1440,11 +1440,13 @@
</div>
<div class="pull-left">
#{bundle['file.viewDiffDialog.version']}: #{DatasetPage.datasetVersionDifference.originalVersion.semanticVersion}<br/>
#{bundle['file.viewDiffDialog.lastUpdated']}: #{DatasetPage.datasetVersionDifference.originalVersion.localeLastUpdateTime}
#{bundle['file.viewDiffDialog.lastUpdated']}: #{DatasetPage.datasetVersionDifference.originalVersion.localeLastUpdateTime}<br/>
<p:fragment rendered="#{versionNoteEnabled}">#{bundle['file.viewDiffDialog.versionNote']}: #{DatasetPage.datasetVersionDifference.originalVersion.versionNote}</p:fragment>
</div>
<div class="pull-left">
#{bundle['file.viewDiffDialog.version']}: #{DatasetPage.datasetVersionDifference.newVersion.semanticVersion}<br/>
#{bundle['file.viewDiffDialog.lastUpdated']}: #{DatasetPage.datasetVersionDifference.newVersion.localeLastUpdateTime}
#{bundle['file.viewDiffDialog.lastUpdated']}: #{DatasetPage.datasetVersionDifference.newVersion.localeLastUpdateTime}<br/>
<p:fragment rendered="#{versionNoteEnabled}">#{bundle['file.viewDiffDialog.versionNote']}: #{DatasetPage.datasetVersionDifference.newVersion.versionNote}</p:fragment>
</div>
</div>
<ui:fragment rendered="#{!empty(DatasetPage.datasetVersionDifference.detailDataByBlock)}">
Expand Down
⚡