@beauraines/sprint-tracker 0.6.3 → 0.6.5

package/.github/workflows/publish.yml

@@ -21,7 +21,7 @@ jobs:
       - name: setup node
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 18.x
           registry-url: 'https://registry.npmjs.org'
       - name: npm install
         run: npm ci

package/.github/workflows/test.yaml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [16.x, '18.x', '20.x']
 
     steps:
       - uses: actions/checkout@v3

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.6.5](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.4...v0.6.5) (2023-12-13)
+
+
+### Features
+
+* depends on local R ([#46](https://bitbucket.org/beauraines/sprint-tracker/issues/46)) ([1e8bf5e](https://bitbucket.org/beauraines/sprint-tracker/commit/1e8bf5ed534f52e569bab60cf501826b0f9b06f6))
+
+### [0.6.4](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.3...v0.6.4) (2023-12-07)
+
+
+### Bug Fixes
+
+* **config:** creates file when one doesn't exist ([#44](https://bitbucket.org/beauraines/sprint-tracker/issues/44)) ([1b3b525](https://bitbucket.org/beauraines/sprint-tracker/commit/1b3b525ecc7da1c884417cabf5c1b5aa06c01025)), closes [#42](https://bitbucket.org/beauraines/sprint-tracker/issues/42)
+
 ### [0.6.3](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.1...v0.6.3) (2023-12-07)
 
 

package/R/sprintOutcomesCli.R

@@ -3,7 +3,7 @@ library(ggplot2)
 
 # sqlite3 --header --csv tracker.db < sql/sprintOutcomes.sql > /tmp/outcomes.csv
 
-outcomes = read_csv('/tmp/outcomes.csv')
+outcomes = read_csv('~/outcomes.csv')
 
 outcomes <- outcomes %>% 
   tibble() %>%
@@ -98,6 +98,6 @@ plot<-ggplot(outcomes,
 
 # plot # commented out for docker
 
-ggsave(str_c("~/projects/sprint-tracker/",str_replace(unique(outcomes$project_name)," ",""),"SprintOutcomesCli.png"),plot=plot,bg="white", width = 2882, height = 1700, units =  "px")
+ggsave(str_c("~/",str_replace(unique(outcomes$project_name)," ",""),"SprintOutcomesCli.png"),plot=plot,bg="white", width = 2882, height = 1700, units =  "px")
 
-print(str_c("Saving to ",str_c("~/projects/sprint-tracker/",str_replace(unique(outcomes$project_name)," ",""),"SprintOutcomesCli.png"),sep = " "))
+print(str_c("Saving to ",str_c("~/",str_replace(unique(outcomes$project_name)," ",""),"SprintOutcomesCli.png"),sep = " "))

package/README.md

@@ -40,15 +40,22 @@ Options:
 ```
 ## Dependencies
 
-This CLI application relies on a local [sqlite](https://www.sqlite.org/download.html) database, [docker](https://docs.docker.com/desktop/?_gl=1*ogftl2*_ga*OTE5MjI3MDc1LjE3MDE5MDA5NTE.*_ga_XJWPQMJYHQ*MTcwMTkwMDk1MS4xLjEuMTcwMTkwMDk5My4xOC4wLjA.), and the [rocker](https://hub.docker.com/r/rocker/tidyverse)/tidyverse](https://hub.docker.com/r/rocker/tidyverse) image to function. Installation of these dependencies is outside of the scope of this project as the steps vary by OS.
+This CLI application relies on a local [sqlite](https://www.sqlite.org/download.html) database, [R](https://cran.r-project.org/) including [tidyverse](https://tidyverse.tidyverse.org/) to function. Installation of these dependencies is outside of the scope of this project as the steps vary by OS.
 
 On Mac, these can be installed with homebrew.
 
 ```bash
-brew install docker sqlite
-docker pull rocker/tidyverse
+brew install sqlite r
 ```
 
+Install the tidyverse packages
+
+1. Start R with the `R` command
+2. Install tidyverse `install.packages("tidyverse")`
+3. Pick a close mirror from the list provided
+4. A very long compile process will run, approximately 20 minutes depending upon your hardware.
+5. Once it is installed quit R with `q()` and respond to the prompts to **not** save your workspace.
+
 ## Installation Instructions
 
 The sprint-tracker can be installed with `npm -g i @beauraines/sprint-tracker` to be used locally. Once you've installed it, follow the [General Usage](#general-usage) instructions. If you're going to contribute to the package, see [Installation and Setup for Development](#installation-and-setup-for-development).
@@ -61,7 +68,7 @@ The sprint-tracker can be installed with `npm -g i @beauraines/sprint-tracker` t
 8. Run `sprint-tracker addProject` to add a project to the database. This step can be repeated as new projects are started.
 9.  Add the first sprint with `sprint-tracker addSprint` optionally, adding the sprint commitment. This step can be repeated for subsequent sprints.
 10. At the end of the sprint, record sprint outcomes `sprint-tracker addOutcome`. This will allow you to log information about stories and points completed, committed, pulled forward, carried over, and bugs.
-11. Generate the cumulative sprint outcomes visualization with `sprint-tracker visualizations`. If you do not have the [rocker/tidyverse](https://hub.docker.com/r/rocker/tidyverse) image, it will automatically pull it, which will take a little bit of time
+11. Generate the cumulative sprint outcomes visualization with `sprint-tracker visualizations`. 
 
 
 ## Configuration
@@ -97,13 +104,13 @@ Non-working days and PTO will be recorded to be able to normalize Sprints with d
 
 ### Sprint Outcomes
 
-1. Commitment : Initial sprint commitment
-1. Delivered : Work completed this sprint
-1. Unplanned - Story : All unplanned work brought into the sprint, whether completed or not
-1. Unplanned - Bug : Unplanned work without a pre-existing story that was deemed critical enough to add to the sprint
-1. Descoped : Committed work, removed from the sprint
-1. Carryover : Incomplete, started or unstarted, work from this sprint, assumed that it will carryover to the next sprint
-1. Carryover - External : Work that was carried over due to blockers external to the scrum team. Use of this is optional, as an agile team should be fully self-sufficient.
+1. Commitment: Initial sprint commitment
+1. Delivered: Work completed this sprint
+1. Unplanned - Story: All unplanned work brought into the sprint, whether completed or not
+1. Unplanned - Bug: Unplanned work without a pre-existing story that was deemed critical enough to add to the sprint
+1. Descoped: Committed work, removed from the sprint
+1. Carryover: Incomplete, started or un-started, work from this sprint, assumed that it will carry over to the next sprint
+1. Carryover - External: Work that was carried over due to blockers external to the scrum team. Use of this is optional, as an agile team should be fully self-sufficient.
 
 
 ### ERD
@@ -170,14 +177,14 @@ docker run -it --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ ${IMAGE} su -c 'Rs
 ## Roadmap
 
 1. ~~Build local database using sqlite3~~
-2. ~~Script visualizations, possibly with R, graph-cli, chartsjs, PowerBI or AWS QuickSight~~
+2. ~~Script visualizations, possibly with R, graph-cli, chartsjs, PowerBI, or AWS QuickSight~~
 3. [Backlog health tracking](https://github.com/beauraines/sprint-tracker/issues/36)
 4. Write API for adding data
 5. Write API for getting visualizations
 6. ~~Create database migrations~~
 7. Deploy to cloud
 8. Add sprint metrics
-    1. Average velocity over life of project
+    1. Average velocity over the life of the project
     2. Recent average velocity
     3.  90% confidence range. See <https://resources.scrumalliance.org/Article/its-target-forecast>
     4.  Daily points per developer

package/cmds/config.js

@@ -13,7 +13,7 @@ const handler = async function () {
     const filename = 'sprintTracker.json'
     const configFile = path.join(homedir(), filename)
 
-    if (helpers.fileExists(configFile)) {
+    if (await helpers.fileExists(configFile)) {
         console.error(`Aborting. Existing configuration file ${configFile} found to not overwrite your values.`)
         process.exit(1)
     }

package/cmds/visualizations.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 const { AsyncParser } = require('@json2csv/node')
-const {homedir, tmpdir} = require('os');
+const { homedir } = require('os');
 const { 	database: db	} = require('helpers')
 const { prompt } = require('../utils/input.js')
 const {readConfig} =  require('helpers').config
@@ -82,7 +82,7 @@ const handler = async function () {
     // Write to file
     
 
-    const outputFile = path.join(tmpdir(),'outcomes.csv');
+    const outputFile = path.join(homedir(),'outcomes.csv');
     try {
         fs.writeFileSync(outputFile, csv);
         // file written successfully
@@ -94,10 +94,11 @@ const handler = async function () {
 
 
     console.log('Making visualizations')
-    // Run docker command
-    let PROJECT_DIR=path.join(homedir(),'projects')
-    let IMAGE='rocker/tidyverse'
-    const cmd = `docker run -t --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ -v ${tmpdir()}:/tmp ${IMAGE} su -c 'Rscript /home/rstudio/projects/sprint-tracker/R/sprintOutcomesCli.R' rstudio`
+    // // Run docker command
+    // let PROJECT_DIR=path.join(homedir(),'projects')
+    // let IMAGE='rocker/tidyverse'
+    // const cmd = `docker run -t --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ -v ${tmpdir()}:/tmp ${IMAGE} su -c 'Rscript /home/rstudio/projects/sprint-tracker/R/sprintOutcomesCli.R' rstudio`
+    const cmd = `Rscript ${__dirname}/../R/sprintOutcomesCli.R`
     exec(cmd, function(err, stdout, stderr) {
     if (err) {
         console.log(stderr);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/sprint-tracker",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "Database and R visualizations to track sprint performance",
   "main": "cli.js",
   "bin": {