Skip to content
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.

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

Include version number in deployed artifacts #219

Open
dmcassel opened this issue Feb 5, 2025 · 2 comments
Open

Include version number in deployed artifacts #219

dmcassel opened this issue Feb 5, 2025 · 2 comments
Labels
enhancement New feature or request

Comments

@dmcassel
Copy link
Collaborator

dmcassel commented Feb 5, 2025

After deploying a project that uses marklogic-unit-test, there is nothing in MarkLogic that indicates what version of marklogic-unit-test was deployed. In scenarios where an environment is not updated for an extended period, that would be useful information.

There's probably a reasonably simple way to include a .txt file with the version number in the packaged artifacts, which would end up in the modules database of a project that uses the framework. Even better -- could it be injected into default.xqy to display in the UI?

@dmcassel dmcassel added the enhancement New feature or request label Feb 5, 2025
@rjrudin
Copy link
Contributor

rjrudin commented Feb 5, 2025

Would you want the version to be in some response from the REST extension, or possibly from a new REST extension that only returns the version (and possibly other metadata in the future)?

@dmcassel
Copy link
Collaborator Author

dmcassel commented Feb 8, 2025

@rjrudin I can imagine a couple options for this.

  • Added to setup.xqy to be part of server-side display build.
  • Added to an API that setup.xqy's client-side JS could call and display (which would also allow other ways of getting the info)
  • .\gradlew.bat mlUnitTest --version. This could be useful when running tests in pipelines.

I think having it visible in the UI and through a gradle task would be great. If I had to pick one, I'd lean toward the UI based on how I use the framework, but others might feel differently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants