Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhis2/analytics
Shared components and modules for building DHIS 2 analytics apps
https://github.com/dhis2/analytics
synced-settings tx web-lib
Last synced: 2 days ago
JSON representation
Shared components and modules for building DHIS 2 analytics apps
- Host: GitHub
- URL: https://github.com/dhis2/analytics
- Owner: dhis2
- License: bsd-3-clause
- Created: 2019-04-03T11:58:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-08T14:43:54.000Z (10 days ago)
- Last Synced: 2024-11-09T23:03:50.821Z (8 days ago)
- Topics: synced-settings, tx, web-lib
- Language: JavaScript
- Homepage:
- Size: 8.73 MB
- Stars: 8
- Watchers: 26
- Forks: 12
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Analytics
**master**
[](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
**24.x**
[](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
## Overview
The analytics library contains components and modules that are used in DHIS 2 analytics apps, including:
- [dhis2/dashboards-app](https://github.com/dhis2/dashboards-app)
- [dhis2/data-visualizer-app](https://github.com/dhis2/data-visualizer-app)
- [dhis2/maps-app](https://github.com/dhis2/maps-app)
- [dhis2/line-listing-app](https://github.com/dhis2/line-listing-app)
[Module layout documentation](./docs/module-layout.md)
## Publishing
The analytics package is published to npm as @dhis2/analytics.
To publish, mark the commit using [semantic release terminology](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) (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](https://github.com/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",
...
}
```
2. 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](https://jira.dhis2.org)
under the [LIBS](https://jira.dhis2.org/projects/LIBS) project.
Deep links:
- [Bug](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10006&components=11023)
- [Improvement](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10002&components=11023)
- [New Feature](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10005&components=11023)
- [Task](https://jira.dhis2.org/secure/CreateIssueDetails!init.jspa?pid=10700&issuetype=10003&components=11023)