Expose buildVersion (deployed-version info) on REST root (#813) - #1416
Merged
Conversation
Port the deployed-commit info feature from dtq-dev so the backend reports which commit is currently deployed via `buildVersion` on the REST root endpoint (/server/api): - scripts/sourceversion.py generates dspace/config/VERSION_D.txt (git hash, commit date, build-run link) at Docker build time. - .github/workflows/docker.yml runs the version script before the image build. - clarin-dspace.cfg: build.version.file.path points at the generated file. - RootConverter reads that file and sets RootRest.buildVersion; RootRest gets the buildVersion field (getter/setter, equals/hashCode). - dspace/config/VERSION_D.txt committed as an empty placeholder (overwritten at build). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds deployed build metadata to the REST root endpoint as buildVersion.
Changes:
- Generates version metadata during Docker builds.
- Configures and reads the generated version file.
- Exposes
buildVersionthroughRootRest.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Summary |
|---|---|
scripts/sourceversion.py |
Generates build metadata. |
dspace/config/VERSION_D.txt |
Provides an empty placeholder. |
dspace/config/clarin-dspace.cfg |
Configures the version file path. |
dspace-server-webapp/src/main/java/org/dspace/app/rest/model/RootRest.java |
Adds the buildVersion field. |
dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RootConverter.java |
Reads and exposes build metadata. Two moderate findings: close readers with try-with-resources and add coverage for configured, missing, and empty files. |
.github/workflows/docker.yml |
Generates version metadata before image builds. |
Suppressed comments (1)
dspace-server-webapp/src/main/java/org/dspace/app/rest/converter/RootConverter.java:61
readLine()removes each line separator, and the loop never restores one, so the generated value becomes...+0200Git hash: ...and any multi-line metadata is ambiguously concatenated. Preserve a separator when appending each line so the exposed build information remains readable.
while ((line = bufferedReader.readLine()) != null) {
buildVersion.append(line);
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why (issue #813)
Expose which commit is currently deployed as
buildVersionon the REST root endpoint (/server/api), matchingdtq-dev. This branch had none of it.Changes
scripts/sourceversion.py— generatesdspace/config/VERSION_D.txt(git hash, commit date, build run) at Docker build time..github/workflows/docker.yml— new Add version step runs the script before the image build.dspace/config/clarin-dspace.cfg—build.version.file.pathpoints at the generated file.RootConverterreads the file intoRootRest.buildVersion;RootRestgains thebuildVersionfield (getter/setter, equals/hashCode).dspace/config/VERSION_D.txt— empty placeholder (overwritten at build).Verification
dspace-server-webappcompiles.buildVersionappears onGET /server/api(empty until the file is generated by CI).🤖 Generated with Claude Code