@beauraines/sprint-tracker 0.6.1 → 0.6.3

package/.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+name: 'Publish to NPM'
+
+on:
+  workflow_run:
+    workflows: ['Node.js CI']
+    types: [completed]
+    branches: [master,main]
+
+jobs:
+  publish-new-version:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: '0'
+      - name: git setup
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: 'https://registry.npmjs.org'
+      - name: npm install
+        run: npm ci
+
+      - name: Should release
+        id: should_release
+        continue-on-error: true
+        run: npm run should-release -- -v
+
+      - name: No release
+        if: steps.should_release.outcome != 'success'
+        run: echo "No release required. Skipping publishing."
+
+      - name: Version bump
+        if: steps.should_release.outcome == 'success'
+        run: npm run release
+
+      - name: Publish to NPM
+        if: steps.should_release.outcome == 'success'
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Push commits to GitHub
+        if: steps.should_release.outcome == 'success'
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
+          tags: true

package/.github/workflows/test.yaml

@@ -0,0 +1,27 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run build --if-present
+      - run: npm test -- --passWithNoTests

package/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 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.3](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.1...v0.6.3) (2023-12-07)
+
+
+### Features
+
+* Add database seeds ([0cdc547](https://bitbucket.org/beauraines/sprint-tracker/commit/0cdc547d75ee2f91fb04c779cf7179548c0af536)), closes [#21](https://bitbucket.org/beauraines/sprint-tracker/issues/21)
+* Add new project command ([bb55704](https://bitbucket.org/beauraines/sprint-tracker/commit/bb557046848ad5e9be3e1cb479a9a9695fbb3adf)), closes [#2](https://bitbucket.org/beauraines/sprint-tracker/issues/2)
+* adds bash completion ([52d217d](https://bitbucket.org/beauraines/sprint-tracker/commit/52d217d455fe7ed88a817735f07b0e6d816786d7))
+* adds command to generate Sprint Outcome visualization ([671c350](https://bitbucket.org/beauraines/sprint-tracker/commit/671c350144625296675028b57e9cfada0dc204cc))
+* adds command to prompt and add project ([e9c788e](https://bitbucket.org/beauraines/sprint-tracker/commit/e9c788e3c80edadf593be73a6d48edaef42cfdc1)), closes [#2](https://bitbucket.org/beauraines/sprint-tracker/issues/2)
+* adds config command ([e5d1f4e](https://bitbucket.org/beauraines/sprint-tracker/commit/e5d1f4e2ded5d5e8bb0e930575314088c583c1f0))
+* adds docker compose file ([0a2fffc](https://bitbucket.org/beauraines/sprint-tracker/commit/0a2fffc7e6b8d8c15b88fd130528fd8f3e51fd02))
+* adds shell script to generate backlog by team ([5063a42](https://bitbucket.org/beauraines/sprint-tracker/commit/5063a427613a307da3a26dd2c6f561dd0e234e8b))
+* compensates for unestimated work-items ([#19](https://bitbucket.org/beauraines/sprint-tracker/issues/19)) ([79bfa68](https://bitbucket.org/beauraines/sprint-tracker/commit/79bfa68bc30a6244416af10fcb26007957ee0f0f))
+* makes config path work cross-OS ([4fae74b](https://bitbucket.org/beauraines/sprint-tracker/commit/4fae74b4ba45f5bf0f6d62c7b924d2ead01d0d73))
+* Prettify output with cli-table3 ([682b72f](https://bitbucket.org/beauraines/sprint-tracker/commit/682b72f343c4cb34e8b36bb907065993f09b4c70)), closes [#5](https://bitbucket.org/beauraines/sprint-tracker/issues/5)
+* **README:** adds installation instructions ([7ed182f](https://bitbucket.org/beauraines/sprint-tracker/commit/7ed182fa7676aa6d5b37f001d4d413e86fe9ee83))
+* removes description from sprint display ([1ebd19e](https://bitbucket.org/beauraines/sprint-tracker/commit/1ebd19e3aca1c9dbaed021b84963b4dc7aa3e135))
+* saves feature team backlog to a file ([01e79b5](https://bitbucket.org/beauraines/sprint-tracker/commit/01e79b53b9e067e33151e6d4f38b47900c7439ae))
+* scripts to create visualizations ([a6aa4f8](https://bitbucket.org/beauraines/sprint-tracker/commit/a6aa4f861e526a5abb7fc9cb77af2c719aae1b24))
+* **visuals:** Updates sprint outcomes legend ([b2010db](https://bitbucket.org/beauraines/sprint-tracker/commit/b2010db22c310c341dbe8075a596bbedff7dbd25))
+
+
+### Bug Fixes
+
+* removes extraneous db output console logging ([#35](https://bitbucket.org/beauraines/sprint-tracker/issues/35)) ([c07e318](https://bitbucket.org/beauraines/sprint-tracker/commit/c07e3183df934dc8a2d796fd7ad68c94163bf91d)), closes [#14](https://bitbucket.org/beauraines/sprint-tracker/issues/14)
+* removes unneeded log statement ([92cca30](https://bitbucket.org/beauraines/sprint-tracker/commit/92cca30b1a3101bf8038cd8c03110bd091e5392a))
+* **tracker:** adding sprint with out commmitment ([3cf79fa](https://bitbucket.org/beauraines/sprint-tracker/commit/3cf79fa7805fe2f1b820378336935c545daf29ce))
+
 ### [0.6.1](https://bitbucket.org/beauraines/sprint-tracker/compare/v0.6.0...v0.6.1) (2023-03-25)
 
 

package/README.md

@@ -49,6 +49,11 @@ brew install docker sqlite
 docker pull rocker/tidyverse
 ```
 
+## 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).
+
+
 ## General Usage
 
 1. Update the config file with the path to the database `sprint-tracker config`. The database doesn't need to exist yet. This step only needs to be done the first time.
@@ -177,5 +182,6 @@ docker run -it --rm -v ${PROJECT_DIR}:/home/rstudio/projects/ ${IMAGE} su -c 'Rs
     3.  90% confidence range. See <https://resources.scrumalliance.org/Article/its-target-forecast>
     4.  Daily points per developer
 
+## Contributing
 
-
+Please feel free to contribute by opening a pull request!

package/cmds/addOutcomes.js

@@ -87,6 +87,7 @@ const handler = async function () {
 		delete outcome.outcome_name
 		delete outcome.outcome_description
 	}
+	// eslint-disable-next-line no-unused-vars
 	let result = await db.insert(database,'sprint_outcomes',sprintOutcomes,['sprint_id','outcome_id'])
 }
 

package/package.json

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

package/src/addOutcomes.js

@@ -71,6 +71,7 @@ async function main() {
 	console.log(sprintOutcomes)
 	
 	// Save outcomes to DB
+	// eslint-disable-next-line no-unused-vars
 	let result = await db.insert(database,'sprint_outcomes',sprintOutcomes,['sprint_id','outcome_id'])
 }
 

package/src/addSprint.js

@@ -90,6 +90,7 @@ async function main() {
 
 main()
 
+// eslint-disable-next-line no-unused-vars
 function promptForInput(items,promptText) {
 	let id
 	for (const item of items) {

package/utils/readConfig.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const { helpers, database	} = require('helpers')
+const { helpers	} = require('helpers')
 
 /**
  * Reads the specified config file
@@ -7,7 +7,7 @@ const { helpers, database	} = require('helpers')
  * @param {string} configFile the fully qualified path and file name for the config file
  * @returns {object} the configuration object
  */
-readConfig = async (configFile) => {
+const readConfig = async (configFile) => {
 
 	let config
 	if ( await helpers.fileExists(configFile) ) {
@@ -33,7 +33,7 @@ readConfig = async (configFile) => {
  * @throws {Invalid configuration file}
  * @returns {boolean} 
  */
-validateConfig = async (configFile, configProps) => {
+const validateConfig = async (configFile, configProps) => {
     if (! fs.existsSync(configFile) ) {
         throw new Error('Configuration file not found')
     }
@@ -43,7 +43,7 @@ validateConfig = async (configFile, configProps) => {
     config = JSON.parse(config);
     // Check for properties
     let validConfig = true
-    for (key of configProps) {
+    for (const key of configProps) {
         validConfig = config[key] ? true : false
     }
 
@@ -60,9 +60,9 @@ validateConfig = async (configFile, configProps) => {
  * @param {Array} configProps an array of properties that defines a valid config file
  * 
  */
-createConfig = async (configFile,configProps) => {
+const createConfig = async (configFile,configProps) => {
     let config = {}
-    for (key of configProps) {
+    for (const key of configProps) {
         config[key] = ''
     }
     fs.writeFileSync(configFile,JSON.stringify(config))
@@ -70,5 +70,6 @@ createConfig = async (configFile,configProps) => {
 
 module.exports = {
     readConfig,
-    createConfig
+    createConfig,
+    validateConfig
 }