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

(docs) Improve versioning and releasing documentation #1244

Merged
merged 2 commits into from
Dec 17, 2024
Merged

Conversation

denniskigen
Copy link
Member

@denniskigen denniskigen commented Dec 17, 2024

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

This PR improves the README by making the following changes:

  • Add clear instructions for major version updates with examples
  • Add missing packages to the framework packages list
  • Improve formatting and readability of version management section
  • Fix typos

Screenshots

Related Issue

Other

This PR improves the README by making the following changes:

- Add clear instructions for major version updates with examples
- Add missing packages to the framework packages list
- Fix typos in README (stlyeguide -> styleguide, wihout -> without)
- Improve formatting and readability of version management section
Copy link
Contributor

github-actions bot commented Dec 17, 2024

Size Change: 0 B

Total Size: 6.17 MB

ℹ️ View Unchanged
Filename Size
packages/apps/esm-devtools-app/dist/593.js 149 kB
packages/apps/esm-devtools-app/dist/642.js 21.1 kB
packages/apps/esm-devtools-app/dist/657.js 7.02 kB
packages/apps/esm-devtools-app/dist/735.js 2.63 kB
packages/apps/esm-devtools-app/dist/762.js 4.1 kB
packages/apps/esm-devtools-app/dist/788.js 42.9 kB
packages/apps/esm-devtools-app/dist/875.js 11.6 kB
packages/apps/esm-devtools-app/dist/889.js 375 kB
packages/apps/esm-devtools-app/dist/988.js 326 B
packages/apps/esm-devtools-app/dist/main.js 3.23 kB
packages/apps/esm-devtools-app/dist/openmrs-esm-devtools-app.js 3.28 kB
packages/apps/esm-help-menu-app/dist/167.js 1.07 kB
packages/apps/esm-help-menu-app/dist/248.js 9.89 kB
packages/apps/esm-help-menu-app/dist/611.js 2.45 kB
packages/apps/esm-help-menu-app/dist/642.js 21.1 kB
packages/apps/esm-help-menu-app/dist/657.js 7.02 kB
packages/apps/esm-help-menu-app/dist/662.js 147 kB
packages/apps/esm-help-menu-app/dist/735.js 2.63 kB
packages/apps/esm-help-menu-app/dist/788.js 42.9 kB
packages/apps/esm-help-menu-app/dist/889.js 375 kB
packages/apps/esm-help-menu-app/dist/958.js 3.74 kB
packages/apps/esm-help-menu-app/dist/main.js 8.56 kB
packages/apps/esm-help-menu-app/dist/openmrs-esm-help-menu-app.js 3.23 kB
packages/apps/esm-implementer-tools-app/dist/152.js 594 B
packages/apps/esm-implementer-tools-app/dist/236.js 592 B
packages/apps/esm-implementer-tools-app/dist/240.js 593 B
packages/apps/esm-implementer-tools-app/dist/261.js 594 B
packages/apps/esm-implementer-tools-app/dist/271.js 755 B
packages/apps/esm-implementer-tools-app/dist/272.js 594 B
packages/apps/esm-implementer-tools-app/dist/289.js 14.2 kB
packages/apps/esm-implementer-tools-app/dist/319.js 687 B
packages/apps/esm-implementer-tools-app/dist/336.js 137 kB
packages/apps/esm-implementer-tools-app/dist/36.js 2.49 kB
packages/apps/esm-implementer-tools-app/dist/378.js 698 B
packages/apps/esm-implementer-tools-app/dist/426.js 27.8 kB
packages/apps/esm-implementer-tools-app/dist/441.js 4.38 kB
packages/apps/esm-implementer-tools-app/dist/448.js 4.66 kB
packages/apps/esm-implementer-tools-app/dist/460.js 789 B
packages/apps/esm-implementer-tools-app/dist/491.js 134 kB
packages/apps/esm-implementer-tools-app/dist/539.js 592 B
packages/apps/esm-implementer-tools-app/dist/566.js 591 B
packages/apps/esm-implementer-tools-app/dist/574.js 593 B
packages/apps/esm-implementer-tools-app/dist/587.js 2.93 kB
packages/apps/esm-implementer-tools-app/dist/625.js 594 B
packages/apps/esm-implementer-tools-app/dist/642.js 21.1 kB
packages/apps/esm-implementer-tools-app/dist/644.js 751 B
packages/apps/esm-implementer-tools-app/dist/652.js 594 B
packages/apps/esm-implementer-tools-app/dist/657.js 7.03 kB
packages/apps/esm-implementer-tools-app/dist/667.js 121 kB
packages/apps/esm-implementer-tools-app/dist/673.js 593 B
packages/apps/esm-implementer-tools-app/dist/705.js 594 B
packages/apps/esm-implementer-tools-app/dist/711.js 594 B
packages/apps/esm-implementer-tools-app/dist/727.js 593 B
packages/apps/esm-implementer-tools-app/dist/735.js 2.63 kB
packages/apps/esm-implementer-tools-app/dist/737.js 593 B
packages/apps/esm-implementer-tools-app/dist/744.js 722 B
packages/apps/esm-implementer-tools-app/dist/757.js 703 B
packages/apps/esm-implementer-tools-app/dist/788.js 42.9 kB
packages/apps/esm-implementer-tools-app/dist/807.js 592 B
packages/apps/esm-implementer-tools-app/dist/833.js 729 B
packages/apps/esm-implementer-tools-app/dist/845.js 6.43 kB
packages/apps/esm-implementer-tools-app/dist/859.js 3.09 kB
packages/apps/esm-implementer-tools-app/dist/873.js 3.67 kB
packages/apps/esm-implementer-tools-app/dist/889.js 375 kB
packages/apps/esm-implementer-tools-app/dist/899.js 590 B
packages/apps/esm-implementer-tools-app/dist/main.js 21 kB
packages/apps/esm-implementer-tools-app/dist/openmrs-esm-implementer-tools-app.js 3.4 kB
packages/apps/esm-login-app/dist/202.js 2.57 kB
packages/apps/esm-login-app/dist/211.js 34.9 kB
packages/apps/esm-login-app/dist/236.js 777 B
packages/apps/esm-login-app/dist/240.js 842 B
packages/apps/esm-login-app/dist/261.js 753 B
packages/apps/esm-login-app/dist/271.js 936 B
packages/apps/esm-login-app/dist/272.js 765 B
packages/apps/esm-login-app/dist/319.js 868 B
packages/apps/esm-login-app/dist/336.js 838 B
packages/apps/esm-login-app/dist/378.js 879 B
packages/apps/esm-login-app/dist/415.js 26.7 kB
packages/apps/esm-login-app/dist/460.js 991 B
packages/apps/esm-login-app/dist/539.js 783 B
packages/apps/esm-login-app/dist/566.js 897 B
packages/apps/esm-login-app/dist/574.js 752 B
packages/apps/esm-login-app/dist/593.js 149 kB
packages/apps/esm-login-app/dist/625.js 753 B
packages/apps/esm-login-app/dist/63.js 16.5 kB
packages/apps/esm-login-app/dist/642.js 21.1 kB
packages/apps/esm-login-app/dist/644.js 930 B
packages/apps/esm-login-app/dist/652.js 753 B
packages/apps/esm-login-app/dist/657.js 7.02 kB
packages/apps/esm-login-app/dist/673.js 792 B
packages/apps/esm-login-app/dist/676.js 2.23 kB
packages/apps/esm-login-app/dist/7.js 3.03 kB
packages/apps/esm-login-app/dist/705.js 753 B
packages/apps/esm-login-app/dist/711.js 752 B
packages/apps/esm-login-app/dist/727.js 752 B
packages/apps/esm-login-app/dist/735.js 2.62 kB
packages/apps/esm-login-app/dist/737.js 752 B
packages/apps/esm-login-app/dist/744.js 1.01 kB
packages/apps/esm-login-app/dist/755.js 3.36 kB
packages/apps/esm-login-app/dist/757.js 913 B
packages/apps/esm-login-app/dist/788.js 42.9 kB
packages/apps/esm-login-app/dist/807.js 1.05 kB
packages/apps/esm-login-app/dist/833.js 889 B
packages/apps/esm-login-app/dist/859.js 3.08 kB
packages/apps/esm-login-app/dist/889.js 375 kB
packages/apps/esm-login-app/dist/899.js 750 B
packages/apps/esm-login-app/dist/93.js 2.16 kB
packages/apps/esm-login-app/dist/main.js 63.1 kB
packages/apps/esm-login-app/dist/openmrs-esm-login-app.js 3.46 kB
packages/apps/esm-offline-tools-app/dist/236.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/240.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/261.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/271.js 1.19 kB
packages/apps/esm-offline-tools-app/dist/272.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/319.js 1.16 kB
packages/apps/esm-offline-tools-app/dist/336.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/378.js 1.17 kB
packages/apps/esm-offline-tools-app/dist/460.js 1.3 kB
packages/apps/esm-offline-tools-app/dist/539.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/566.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/574.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/601.js 142 kB
packages/apps/esm-offline-tools-app/dist/625.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/63.js 16.5 kB
packages/apps/esm-offline-tools-app/dist/642.js 21.1 kB
packages/apps/esm-offline-tools-app/dist/644.js 1.19 kB
packages/apps/esm-offline-tools-app/dist/645.js 91.5 kB
packages/apps/esm-offline-tools-app/dist/652.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/657.js 7.02 kB
packages/apps/esm-offline-tools-app/dist/673.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/703.js 6.32 kB
packages/apps/esm-offline-tools-app/dist/705.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/711.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/727.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/735.js 2.63 kB
packages/apps/esm-offline-tools-app/dist/737.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/744.js 1.28 kB
packages/apps/esm-offline-tools-app/dist/757.js 1.19 kB
packages/apps/esm-offline-tools-app/dist/788.js 42.9 kB
packages/apps/esm-offline-tools-app/dist/807.js 1.1 kB
packages/apps/esm-offline-tools-app/dist/833.js 1.21 kB
packages/apps/esm-offline-tools-app/dist/859.js 3.09 kB
packages/apps/esm-offline-tools-app/dist/889.js 375 kB
packages/apps/esm-offline-tools-app/dist/899.js 1.02 kB
packages/apps/esm-offline-tools-app/dist/947.js 8.66 kB
packages/apps/esm-offline-tools-app/dist/main.js 107 kB
packages/apps/esm-offline-tools-app/dist/openmrs-esm-offline-tools-app.js 3.39 kB
packages/apps/esm-primary-navigation-app/dist/236.js 239 B
packages/apps/esm-primary-navigation-app/dist/240.js 240 B
packages/apps/esm-primary-navigation-app/dist/261.js 241 B
packages/apps/esm-primary-navigation-app/dist/271.js 282 B
packages/apps/esm-primary-navigation-app/dist/272.js 240 B
packages/apps/esm-primary-navigation-app/dist/319.js 246 B
packages/apps/esm-primary-navigation-app/dist/336.js 240 B
packages/apps/esm-primary-navigation-app/dist/378.js 267 B
packages/apps/esm-primary-navigation-app/dist/460.js 277 B
packages/apps/esm-primary-navigation-app/dist/482.js 15.2 kB
packages/apps/esm-primary-navigation-app/dist/513.js 146 kB
packages/apps/esm-primary-navigation-app/dist/539.js 239 B
packages/apps/esm-primary-navigation-app/dist/566.js 239 B
packages/apps/esm-primary-navigation-app/dist/574.js 240 B
packages/apps/esm-primary-navigation-app/dist/577.js 7.64 kB
packages/apps/esm-primary-navigation-app/dist/619.js 6.45 kB
packages/apps/esm-primary-navigation-app/dist/625.js 241 B
packages/apps/esm-primary-navigation-app/dist/63.js 16.5 kB
packages/apps/esm-primary-navigation-app/dist/644.js 281 B
packages/apps/esm-primary-navigation-app/dist/652.js 241 B
packages/apps/esm-primary-navigation-app/dist/657.js 7.03 kB
packages/apps/esm-primary-navigation-app/dist/673.js 240 B
packages/apps/esm-primary-navigation-app/dist/705.js 241 B
packages/apps/esm-primary-navigation-app/dist/711.js 240 B
packages/apps/esm-primary-navigation-app/dist/727.js 240 B
packages/apps/esm-primary-navigation-app/dist/735.js 2.63 kB
packages/apps/esm-primary-navigation-app/dist/737.js 240 B
packages/apps/esm-primary-navigation-app/dist/744.js 288 B
packages/apps/esm-primary-navigation-app/dist/757.js 244 B
packages/apps/esm-primary-navigation-app/dist/788.js 42.9 kB
packages/apps/esm-primary-navigation-app/dist/807.js 301 B
packages/apps/esm-primary-navigation-app/dist/833.js 282 B
packages/apps/esm-primary-navigation-app/dist/888.js 24.7 kB
packages/apps/esm-primary-navigation-app/dist/889.js 375 kB
packages/apps/esm-primary-navigation-app/dist/899.js 237 B
packages/apps/esm-primary-navigation-app/dist/933.js 3.63 kB
packages/apps/esm-primary-navigation-app/dist/main.js 30.2 kB
packages/apps/esm-primary-navigation-app/dist/openmrs-esm-primary-navigation-app.js 3.38 kB
packages/framework/esm-api/dist/openmrs-esm-api.js 16.9 kB
packages/framework/esm-config/dist/openmrs-esm-module-config.js 8.42 kB
packages/framework/esm-context/dist/openmrs-esm-context.js 1.16 kB
packages/framework/esm-dynamic-loading/dist/openmrs-esm-dynamic-loading.js 2.89 kB
packages/framework/esm-error-handling/dist/openmrs-esm-error-handling.js 891 B
packages/framework/esm-expression-evaluator/dist/openmrs-esm-expression-evaluator.js 9.02 kB
packages/framework/esm-extensions/dist/openmrs-esm-extensions.js 25.3 kB
packages/framework/esm-feature-flags/dist/openmrs-esm-feature-flags.js 1.66 kB
packages/framework/esm-framework/dist/278.openmrs-esm-framework.js 14.5 kB
packages/framework/esm-framework/dist/530.openmrs-esm-framework.js 2.93 kB
packages/framework/esm-framework/dist/588.openmrs-esm-framework.js 2.15 kB
packages/framework/esm-framework/dist/619.openmrs-esm-framework.js 6.49 kB
packages/framework/esm-framework/dist/645.openmrs-esm-framework.js 9.3 kB
packages/framework/esm-framework/dist/735.openmrs-esm-framework.js 2.65 kB
packages/framework/esm-framework/dist/746.openmrs-esm-framework.js 6.14 kB
packages/framework/esm-framework/dist/788.openmrs-esm-framework.js 42.9 kB
packages/framework/esm-framework/dist/openmrs-esm-framework.js 459 kB
packages/framework/esm-globals/dist/openmrs-esm-globals.js 791 B
packages/framework/esm-navigation/dist/openmrs-esm-navigation.js 9.34 kB
packages/framework/esm-offline/dist/openmrs-esm-offline.js 34.4 kB
packages/framework/esm-react-utils/dist/openmrs-esm-react-utils.js 22 kB
packages/framework/esm-routes/dist/openmrs-esm-utils.js 4.68 kB
packages/framework/esm-state/dist/openmrs-esm-state.js 1.59 kB
packages/framework/esm-styleguide/dist/openmrs-esm-styleguide.js 194 kB
packages/framework/esm-translations/dist/openmrs-esm-core-translations.js 1.89 kB
packages/framework/esm-utils/dist/openmrs-esm-utils.js 45.5 kB
packages/shell/esm-app-shell/dist/0030f1956e452721.js 46.7 kB
packages/shell/esm-app-shell/dist/02af6181aebfc3a3.js 172 kB
packages/shell/esm-app-shell/dist/0bf5f337a1bf9187.js 1.02 kB
packages/shell/esm-app-shell/dist/1a24572453c2e538.js 1.02 kB
packages/shell/esm-app-shell/dist/1af7a4d6b41cd1cd.js 1.02 kB
packages/shell/esm-app-shell/dist/218d03de949106fa.js 1.31 kB
packages/shell/esm-app-shell/dist/283a712fa0ce77a6.js 66.2 kB
packages/shell/esm-app-shell/dist/2ecffd6094f75ff7.js 1.02 kB
packages/shell/esm-app-shell/dist/358c311631fbf075.js 1.02 kB
packages/shell/esm-app-shell/dist/38d4b8fb75f8850c.js 18.3 kB
packages/shell/esm-app-shell/dist/3b01402cd7292844.js 2.85 kB
packages/shell/esm-app-shell/dist/4bc75ee78353dab4.js 1.19 kB
packages/shell/esm-app-shell/dist/4c46128f5543a744.js 1.02 kB
packages/shell/esm-app-shell/dist/53baea24a93b42fc.js 7.12 kB
packages/shell/esm-app-shell/dist/572e81f004cc10c5.js 15.1 kB
packages/shell/esm-app-shell/dist/58675205690e717d.js 1.02 kB
packages/shell/esm-app-shell/dist/5bd4d5d1e74e6532.js 1.2 kB
packages/shell/esm-app-shell/dist/6f47008d9c93c1cb.js 3.33 kB
packages/shell/esm-app-shell/dist/71ab27e0b8d1949e.js 2.58 kB
packages/shell/esm-app-shell/dist/7245ef51b3517bf9.js 1.06 kB
packages/shell/esm-app-shell/dist/79e0fe636d1ed41c.js 1.59 kB
packages/shell/esm-app-shell/dist/7b204450699b0daf.js 2.6 kB
packages/shell/esm-app-shell/dist/8e0d11f862dfbba6.js 626 B
packages/shell/esm-app-shell/dist/932785417ef383b8.js 6.99 kB
packages/shell/esm-app-shell/dist/935dd2c6ef71ecc9.js 1.07 kB
packages/shell/esm-app-shell/dist/965c9d9f6a80b848.js 1.31 kB
packages/shell/esm-app-shell/dist/9c36bff0a4f1503e.js 1.02 kB
packages/shell/esm-app-shell/dist/a528b4b01d62ed17.js 1.02 kB
packages/shell/esm-app-shell/dist/a7792d6252d85b20.js 43 kB
packages/shell/esm-app-shell/dist/a7efa2596cd2be4f.js 168 kB
packages/shell/esm-app-shell/dist/b407f548b6fadfa3.js 3.08 kB
packages/shell/esm-app-shell/dist/b500f36d715a6ea5.js 1.02 kB
packages/shell/esm-app-shell/dist/b87a5878f8961d1a.js 2.23 kB
packages/shell/esm-app-shell/dist/b88532bde74b513a.js 9.41 kB
packages/shell/esm-app-shell/dist/bb04bb60f8aa150f.js 3.04 kB
packages/shell/esm-app-shell/dist/bd8148abf2d524fc.js 1.02 kB
packages/shell/esm-app-shell/dist/c2de24781179b3fc.js 1.29 kB
packages/shell/esm-app-shell/dist/c9ba768259e8702c.js 1.02 kB
packages/shell/esm-app-shell/dist/c9bc7c77210219a8.js 1.02 kB
packages/shell/esm-app-shell/dist/cc0d293bb9b870d9.js 3.38 kB
packages/shell/esm-app-shell/dist/d5082a5140f450d7.js 1.02 kB
packages/shell/esm-app-shell/dist/d80423830df5e906.js 1.31 kB
packages/shell/esm-app-shell/dist/d80464c66e5d20d7.js 3.23 kB
packages/shell/esm-app-shell/dist/dd0262d4e75c15f8.js 1.35 kB
packages/shell/esm-app-shell/dist/e419a658f4742c3e.js 9.36 kB
packages/shell/esm-app-shell/dist/ea114697cfb59962.js 1.02 kB
packages/shell/esm-app-shell/dist/eccc74f925b1e148.js 5.9 kB
packages/shell/esm-app-shell/dist/f368b00f4e1695a5.js 1.02 kB
packages/shell/esm-app-shell/dist/f5c65190072bb3f7.js 626 B
packages/shell/esm-app-shell/dist/fcb385df17a82210.js 6.77 kB
packages/shell/esm-app-shell/dist/ff8fd36f7a9ca50a.js 3.91 kB
packages/shell/esm-app-shell/dist/openmrs.f8f34d1e7caf6da9.js 21.7 kB
packages/shell/esm-app-shell/dist/service-worker.js 46.6 kB
packages/tooling/openmrs/dist/cli.js 3 kB
packages/tooling/openmrs/dist/commands/assemble.js 3.31 kB
packages/tooling/openmrs/dist/commands/build.js 1.34 kB
packages/tooling/openmrs/dist/commands/debug.js 543 B
packages/tooling/openmrs/dist/commands/develop.js 2.71 kB
packages/tooling/openmrs/dist/commands/index.js 437 B
packages/tooling/openmrs/dist/commands/start.js 850 B
packages/tooling/openmrs/dist/index.js 517 B
packages/tooling/openmrs/dist/runner.js 640 B
packages/tooling/openmrs/dist/utils/config.js 726 B
packages/tooling/openmrs/dist/utils/debugger.js 575 B
packages/tooling/openmrs/dist/utils/dependencies.js 643 B
packages/tooling/openmrs/dist/utils/helpers.js 397 B
packages/tooling/openmrs/dist/utils/importmap.js 3.07 kB
packages/tooling/openmrs/dist/utils/index.js 443 B
packages/tooling/openmrs/dist/utils/logger.js 368 B
packages/tooling/openmrs/dist/utils/npmConfig.js 831 B
packages/tooling/openmrs/dist/utils/untar.js 725 B
packages/tooling/openmrs/dist/utils/variables.js 192 B
packages/tooling/openmrs/dist/utils/webpack.js 278 B
packages/tooling/webpack-config/dist/index.js 3.61 kB

compressed-size-action

Comment on lines +30 to +33
- [@openmrs/esm-context](packages/framework/esm-context): provides the AppContext for sharing contextual state across the app
- [@openmrs/esm-dynamic-loading](packages/framework/esm-dynamic-loading): provides functionality for dynamically loading frontend modules using Webpack Module Federation dynamic remotes
- [@openmrs/esm-error-handling](packages/framework/esm-error-handling): handling of errors
- [@openmrs/esm-expression-evaluator](packages/framework/esm-expression-evaluator): provides functions that allow evaluation of user-defined expressions in a way safer than eval()
Copy link
Member

Choose a reason for hiding this comment

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

I feel like I've added too many things to core...

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe we need a new repo lol

README.md Outdated Show resolved Hide resolved
Co-authored-by: Ian <[email protected]>
@denniskigen denniskigen merged commit fc95b35 into main Dec 17, 2024
12 checks passed
@denniskigen denniskigen deleted the docs/readme branch December 17, 2024 19:05
@denniskigen denniskigen mentioned this pull request Jan 15, 2025
4 tasks
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.

2 participants