Skip to content

Shared components and modules for building DHIS 2 analytics apps

License

Notifications You must be signed in to change notification settings

dhis2/analytics

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f1fdd5f · Aug 9, 2024
Mar 30, 2020
Jun 11, 2024
Jun 7, 2021
Dec 9, 2021
Sep 13, 2023
Jun 20, 2023
May 22, 2019
Jul 24, 2024
Aug 9, 2024
Apr 3, 2019
Jun 27, 2019
Dec 11, 2020
Apr 3, 2019
Jun 16, 2021
Mar 30, 2020
Feb 17, 2021
Mar 30, 2020
Aug 8, 2024
Apr 3, 2019
Jun 11, 2024
Mar 11, 2021
Jun 20, 2023
Aug 9, 2024
Aug 9, 2024

Repository files navigation

Analytics

master Test DHIS2: Release

24.x Test DHIS2: Release

Overview

The analytics library contains components and modules that are used in DHIS 2 analytics apps, including:

Module layout documentation

Publishing

The analytics package is published to npm as @dhis2/analytics.

To publish, mark the commit using semantic release terminology (see notes below for branch-specific restrictions). Once committed, github actions will take care of publishing the new version to npm.

master branch

The master branch follows semantic versioning according to spec.

.x branches

Commits to .x branches (e.g. 24.x) cannot trigger a major version bump, even if it is technically a breaking change. This is because the next version has already been published. Additionally, branches that use .x for the patch version (e.g. 11.0.x, 2.4.x), cannot trigger a minor version bump. In the unlikely case that you need to commit a change that would trigger a version bump that's not possible, you will have to mark it to only trigger a patch or minor bump respectively, then make sure to update the apps that are locked to the .x version of analytics

Publishing pre-release versions during app development

Builds for all non-production branches are automatically copied to d2-ci/analytics for use during development and testing, prior to production release.

To test changes in a development branch, change the analytics dependency of package.json of the app you are testing with. There are a few options:

  1. point to a specific commit:
"dependencies": {
        "@dhis2/analytics": "git+https://github.com/d2-ci/analytics.git#70249ebe8be39051fa10142f850de449e1ec488c",
        ...
}
  1. point to a branch:
"dependencies": {
        "@dhis2/analytics": "git+https://github.com/d2-ci/analytics.git#chore/some-chore",
        ...
}

Report an issue

The issue tracker can be found in DHIS2 JIRA under the LIBS project.

Deep links: