Skip to content

Conversation

suubi-joshua
Copy link
Contributor

@suubi-joshua suubi-joshua commented Jun 2, 2025

Requirements

  • This PR has a title that briefly describes the work done including the ticket number. Ensure your PR title includes a conventional commit label (such as feat, fix, or chore, among others). See existing PR titles for inspiration.

For changes to apps

If applicable

  • My work includes tests or is validated by existing tests.
  • I have updated the esm-framework mock to reflect any API changes I have made.

Summary

I have added a configuration to enable implementers add the version number of the distribution. This is beneficial for some implementers to debug when in the field.

Screenshots

Screenshot from 2025-06-02 11-31-42
Screencast from 02-06-25 11:24:07.webm

Related Issue

https://openmrs.atlassian.net/browse/O3-4671

Other

@suubi-joshua suubi-joshua requested a review from pirupius June 2, 2025 09:14
Comment on lines 24 to 25
version: '3.0.0',
showVersion: true,
Copy link
Member

@pirupius pirupius Jun 2, 2025

Choose a reason for hiding this comment

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

Not sure how the others feel but we could default this to false so that it doesn't affect other implementers.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True i thought I had set it to false, my bad.

},
showVersion: {
_type: Type.Boolean,
_default: true,
Copy link
Member

Choose a reason for hiding this comment

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

Let's change this to false since the default value for version is null

@jwnasambu jwnasambu changed the title O3-4671 Adding config to enable implementors add version number. (feat)O3-4671: Adding config to enable implementors add version number. Jul 1, 2025
@jwnasambu
Copy link
Contributor

@suubi-joshua Thank you so much for your work on this PR. Could you kindly fix the merge conflicts, please?

@pirupius
Copy link
Member

pirupius commented Jul 2, 2025

Hi @denniskigen @ibacher do u have any thoughts on this addition.

The background is that we wanted a way to show the version number of the release to end users mostly for error reporting investing issues such as cache. This PR adds a simple optional config to indicate the version number as per this slack thread https://openmrs.slack.com/archives/CKS32D55G/p1745848235764369

@ibacher
Copy link
Member

ibacher commented Jul 8, 2025

If we're going to support a version number, it should be a build-time constant, not set via config. Otherwise, I think the approach is fine.

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

Successfully merging this pull request may close these issues.

4 participants