diff --git a/README.md b/README.md
index d582e4d379..43c868cb00 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@
- [3.2.1 Config Crews/Cycle Time](#321-config-crewscycle-time)
- [3.2.2 Setting Classification](#322-setting-classification)
- [3.2.3 Setting advanced settings](#323-setting-advanced-setting)
- - [3.2.4 Deployment Frequency/Lead Time for Changes](#324-deployment-frequencylead-time-for-changes)
+ - [3.2.4 Pipeline configuration](#324-pipeline-configuration)
- [3.3 Export and import config info](#33-export-and-import-config-info)
- [3.3.1 Export Config Json File](#331-export-config-json-file)
- [3.3.2 Import Config Json File](#332-import-config-json-file)
@@ -33,16 +33,13 @@
- [3.4.4 Deployment Frequency](#344-deployment-frequency)
- [3.4.5 Lead time for changes Data](#345-lead-time-for-changes-data)
- [3.4.6 Change Failure Rate](#346-change-failure-rate)
+ - [3.4.7 Mean time to recovery](#347-mean-time-to-recovery)
- [3.5 Export original data](#35-export-original-data)
- [3.5.1 Export board data](#351-export-board-data)
- [3.5.2 Export pipeline data](#352-export-pipeline-data)
- [3.6 Caching data](#36-caching-data)
-
- [4 Known issues](#4-known-issues)
- - [4.1 Add/Delete columns in Jira board](#41-adddelete-columns-in-jira-board)
- - [4.2 No crew settings for Pipeline and Github](#42-no-crew-settings-for-pipeline-and-github)
- - [4.3 Change failure rate and MTTR](#43-change-failure-rate-and-mttr)
- - [4.4 Change status name in Jira board setting when there are cards in this status](#44-change-status-name-in-jira-board-setting-when-there-are-cards-in-this-status)
+ - [4.1 Change status name in Jira board](#41-change-status-name-in-jira-board-setting-when-there-are-cards-in-this-status)
- [5 Instructions](#5-instructions)
- [5.1 Prepare for Jira Project](#51-prepare-for-jira-project)
- [5.2 Prepare env to use Heartbeat tool](#52-prepare-env-to-use-heartbeat-tool)
@@ -70,6 +67,7 @@
- [Nov 6 2023 - Release Heartbeat - 1.1.2](release-notes/20231106.md)
- [Nov 21 2023 - Release Heartbeat - 1.1.3](release-notes/20231121.md)
- [Dev 4 2023 - Release Heartbeat - 1.1.4](release-notes/20231204.md)
+ - [Feb 29 2024 - Release Heartbeat - 1.1.5](release-notes/20240229.md)
# 1 About Heartbeat
@@ -106,14 +104,14 @@ Here is the user manaul for Version 1 on 2020/06. For now, we just can support J
Before generator the metrics data, user need to config the project info, in Home page (Image3-1), you can create a new project for your project, or you can import a project config json file (If you already saved one config file, for import file feature will introduce in “Import and Export feature ”).
-\
+\
_Image 3-1，home page_
#### 3.1.2 Config search data
If you are first use the product, you need to select “Create A New Project”，it will go to config page (Image 3-2)
-\
+\
_Image 3-2，Project config page_
Users need to select a period of time, then all of the data that follows is based on that time period.
@@ -129,7 +127,7 @@ All need to select which data you want to get, for now, we support seven metrics
- `Classification`: provide different dimensions to view how much efforts team spent within selected time period.
-\
+\
_Image 3-3，Metrics Data_
#### 3.1.3 Config project account
@@ -149,7 +147,7 @@ According to your selected required data, you need to input account settings for
| Mean time to recovery | Pipeline |
-\
+\
Image 3-4，Project config
**The details for board:**
@@ -180,7 +178,7 @@ After inputting the details info, users need to click the `Verify` button to ver
#### 3.2.1 Config Crews/Cycle Time
-\
+\
_Image 3-5, Crews/Cycle Time config_
@@ -202,7 +200,7 @@ _Image 3-5, Crews/Cycle Time config_
#### 3.2.2 Setting Classification
-\
+\
_Image 3-6，Classification Settings_
In classification settings, it will list all Context fields for your jira board. Users can select anyone to get the data for them. And according to your selection, in the export page, you will see the classification report to provide more insight with your board data.
@@ -236,18 +234,19 @@ _Image 3-12，flagged-custom-field_
3. at that time, user can see one api call which headers request URL is https://xxx.atlassian.net/rest/gira/1/ .
4. then go to review part, find fieldDisplayName which show Flagged and story point estimate and get the fieldId as the custom-field that user need to input in advanced settings. from image 3-11 and 3-12 we can find that flagged custom field is customfield_10021, story points custom field is customfield_10016.
-#### 3.2.4 Deployment Frequency/Lead Time for Changes
+#### 3.2.4 Pipeline configuration
-\
+\
_Image 3-13，Settings for Pipeline_
They are sharing the similar settings which you need to specify the pipeline step so that Heartbeat will know in which pipeline and step, team consider it as deploy to PROD. So that we could use it to calculate metrics.
-| Items | Description |
-| ------------- | ----------------------------------- |
-| Organization | The organization for your pipelines |
-| Pipeline Name | Your pipeline name |
-| Steps | The pipeline step that consider as deploy to PROD |
+| Items | Description |
+|---------------|---------------------------------------------------|
+| Organization | The organization for your pipelines |
+| Pipeline Name | Your pipeline name |
+| Steps | The pipeline step that consider as deploy to PROD |
+| Branches | Your selected branches |
## 3.3 Export and import config info
@@ -265,9 +264,12 @@ When user already saved config file before, then you don’t need to create a ne
\
_Image 3-15, Warning message_
-## 3.4 Generate Metrics Data
+## 3.4 Generate Metrics report
+
+After setup and configuration, then it will generate the heartbeat dashboard.
+
-After config, then it will generate the report for you.
+You could find the drill down from `show more >` link from dashboard.
### 3.4.1 Velocity
@@ -279,7 +281,7 @@ _Image 3-16，Velocity Report_
The calculation process data and final result of Cycle Time are calculated by rounding method, and two digits are kept after the decimal point. Such as: 3.567... Is 3.56; 3.564... Is 3.56.
-\
+\
_Image 3-17，Cycle Time Report_
### 3.4.3 Classification
@@ -289,24 +291,29 @@ It will show the classification data of Board based on your selection on `Classi
The percentage value represent the count of that type tickets vs total count of tickets.
-\
+\
_Image 3-18，Classification Report_
### 3.4.4 Deployment Frequency
-\
+\
_Image 3-19，Deployment Frequency Report_
### 3.4.5 Lead time for changes Data
-\
+\
_Image 3-20，Lead time for changes Report_
### 3.4.6 Change Failure Rate
-\
+\
_Image 3-21，Change Failure Rate Report_
+### 3.4.7 Mean time to recovery
+
+\
+_Image 3-22，mean time to recovery
+
## 3.5 Export original data
After generating the report, you can export the original data for your board and pipeline (Image 3-15). Users can click the “Export board data” or “Export pipeline data” button to export the original data.
@@ -379,24 +386,7 @@ _Image 3-23，Exported Pipeline Data_
# 4 Known issues
-## 4.1 Add/Delete columns in Jira board
-
-In the current version, if you add or delete some columns for the jira board, it will change finish time for all last column tickets to add/delete column time. (It just impact Next-gen Jira), here are the details info:
-
-| Jira Template | Add column | Delete column |
-| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Kanban | It will change finish time for all last column tickets to add/delete column time | If delete non-last column: It will change finish time for all last column tickets to add/delete column time
If delete the last column: It will change finish time for current last column tickets to add/delete column time |
-| Scrum | finish time for all last column tickets to add/delete column time
All finished ticket’s finish time changed to add/delete column time | If delete the last column: It will change finish time for current last column tickets to add/delete column time |
-
-
-## 4.2 No crew settings for Pipeline and Github
-In case that not only your team but also other team was contributing on the same repo and pipeline, the metrics (`Lead time for change`, `deployment frenquency`, `change failure rate`, `mean time to recovery`) might not be as accurate which might include the other team's contribution. Because currently Heartbeat could't not differentiate which pipeline trigger by your team or other team within specified time range. The feature is still under development.
-
-## 4.3 Change failure rate and MTTR
-Currently the calculated metrics for change failure rate might not be precise in some scenarios.
-And MTTR is still under development.
-
-## 4.4 Change status name in Jira board setting when there are cards in this status
+## 4.1 Change status name in Jira board setting when there are cards in this status
As an administrator of the jira board, if you modify the workflow to change the status name, it will affect the calculation of duration for cards in that status. Considering the potential loss of duration, changing the status name can lead to loss of precision in cycle time calculation for related cards.
diff --git a/release-notes/20240229.md b/release-notes/20240229.md
new file mode 100644
index 0000000000..ee24144cad
--- /dev/null
+++ b/release-notes/20240229.md
@@ -0,0 +1,21 @@
+# Release Notes
+## Feb 29 2024 - Released Heartbeat 1.1.5
+- New Features
+ - New verification flow improve the performance and user experience
+ - Support multiple Jira status mapping to hearbeat state
+ - Heartbeat dashboard provide a professional view on delivery metrics
+ - Advanced settings to deal with Jira client with limited access permission
+- Enhancement
+ - Support multiple instances in docker-compose or k8s to improve the system performance
+ - Async generate dashboard and detail report
+ - Enable caching
+ - UI refinement
+ - cycle time settings
+ - date picker
+ - pop-up
+- Hotfix
+ - Slow in Kanban board when generating report
+ - Flag as block issue when client has limited access permission
+ - Correct sprint value in exported csv
+
+