DEV Community: Lorna Watson

All deployments regardless of retention period?

Lorna Watson — Tue, 28 Sep 2021 21:42:05 +0000

I've asked in various places including Stackoverflow and at work this question but not getting anything back: how to get a list of all project deployments regardless of retention period (specifically using Octopus Deploy REST API)?

What I'm currently getting: a list of all project deployments as per retention period set.

I believe (might be wrong) it's retention period is set per environment as, for example, for project X I'm getting 2 Live deployments back and in the same project all (by default) of Branch Tests.

I'm wanting to get a list of all project deployments but, to me at least, seems odd I can't get just a list regardless of retention period.

This gets me a list of all deployments but still only get 2 for Live for instance.

HTTP GET: https://<base-url>/api/deployments

Does anyone have idea how to get around this? Or have I missed something? There is documentation online in general but not enough tbh and not this specific.

📊 Calculating DORA Metrics - Deployment Frequency

Lorna Watson — Mon, 27 Sep 2021 00:23:25 +0000

The easiest metric to calculate - get a list of project deployments by environment and then group by date format(s) i.e. by day, by month and by year; and finally to calculate the throughput % score which is essentially:

throughput % = (count of deployments by environment * count of all deployments) * 100

I've parsed the data into a specific format for my charts in the frontend. Check out my repo here.

Result:

{
    "score": 4.16,
    "result": [
        {
            "title": "By Day", 
            "content": [
                {
                    "name": "29 Aug 21",
                    "value": 2
                },
                {
                    "name": "10 Sep 21",
                    "value": 2
                }
            ],
            "average": 2
        },
        {
            "title": "By Month", 
            "content": [
                {
                    "name": "Aug 21",
                    "value": 2
                },
                {
                    "name": "Sep 21",
                    "value": 2
                }
            ],
            "average": 2
        },
        {
            "title": "By Year", 
            "content": [
                {
                    "name": "21",
                    "value": 4
                }
            ],
            "average": null
        }
    ]
}

Thanks for reading!

📊 Intro: DORA Metrics

Lorna Watson — Mon, 27 Sep 2021 00:14:17 +0000

I've created a small Node.js project to calculate DORA Metrics, it's ongoing so is not finished but you can find the repo here.

References/useful links: Accelerate: State of DevOps 2021, DORA metrics explained

What is DORA?

DORA (DevOps Research and Assessment) represents 7 years of research by a team at Google to identify the most effective and efficient ways to develop and deliver software. They surveyed more than 32,000 industry professionals to find out and understand what makes a high performing team different than a low performing team. As a now industry standard, DORA's research has identified four key metrics (depending on where you look will have slightly different names):

Deployment Frequency

Measure throughput by how often an organisation successfully releases to production.

For elite performers: on demand, multiple deploys per day
For high performers: once per week - once per week
For medium performers: once per month - once per 6 months
For low performers: < once per 6 months

Lead Time for Changes

Measure throughput by the amount of time it takes a commit to get into production.

For elite performers: < one hour
For high performers: 1 day - 1 week
For medium performers: 1 month - 6 months
For low performers: > 6 months

Time to Restore Service

Measure stability by how long it takes an organisation to recover from a failure in production.

For elite performers: < 1 hour
For high performers: < 1 day
For medium performers: 1 day - 1 week
For low performers: > 6 months

Change Failure Rate

Measure stability by percentage of deployments causing a failure in production.

For elite performers: 0% - 15%
For high performers: 16% - 30%
For medium performers: 16% - 30%
For low performers: 16% - 30%

✨ Thank you ✨

This is a first post in a series #AllAboutDora, hope this post was useful and interesting!

How does one JQL with the Jira API?

Lorna Watson — Wed, 19 May 2021 22:04:47 +0000

This post is to document, for myself to remember, but also for others who are looking to play with the Jira API - more specifically JQL. I've wrote a list of useful queries here.

The following example assumes:

Base URL is: (you'll need to replace 'host' with yours) https://host.atlassian.net/rest/api/2
TestProject is a real project with a team called Avengers

Example

Get list of bugs in TestProject in current sprint for Avengers team

Authentication

Generate an API token here and copy it somewhere for safe keeping as you're going to need it in a moment.

In the "Authorization" tab, select "Basic Auth" as type with your email address as username and the token you just generated as the password.

Request URL (GET):

https://host.atlassian.net/rest/api/2/search?jql=project=TSTP AND issuetype = "Bug" AND Sprint in openSprints() AND "Engineering Team[Dropdown]" = TSTP-Avengers

Where query params are:

Key	Value
jql	project=TSTP AND issuetype = "Bug" AND Sprint in openSprints() AND "Engineering Team[Dropdown]" = TSTP-Avengers

JSON Response

You'll get back a hefty JSON response which I believe you can filter (not looked into this yet). Please note I've heavily removed bits to focus on the main juicy data you get back without boring the page too much. There are loads of custom fields returned where I believe (again, not looked into this as yet) you can check on your Jira account for a list/create some more.

{
  "expand": "schema,names",
  "startAt": 0,
  "maxResults": 50,
  "total": 1,
  "issues": [
    {
      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields,customfield_16139.properties",
      "id": "44421",
      "self": "https://host.atlassian.net/rest/api/2/issue/44421",
      "key": "TSTP-5980",
      "fields": {
        "resolution": {
          "self": "https://host.atlassian.net/rest/api/2/resolution/10000",
          "id": "10000",
          "description": "Work has been completed on this issue.",
          "name": "Done"
        },
        "lastViewed": "2021-05-19T09:10:22.953+0100",
        "labels": [
          "Tech Debt"
        ],
        "assignee": {
          "displayName": "Lorna Watson"
        },
        "reporter": {
          "displayName": "Bob Smith"
        },
        "customfield_15725": {
          "released": true,
          "releaseDate": "2017-10-25"
        },
        "issuetype": {
          "self": "https://host.atlassian.net/rest/api/2/issuetype/1",
          "id": "1",
          "description": "A problem which impairs or prevents the functions of the product.",
          "iconUrl": "https://host.atlassian.net/secure/viewavatar?size=medium&avatarId=1223&avatarType=issuetype",
          "name": "Bug",
          "subtask": false,
          "avatarId": 1223
        },
        "project": {
          "self": "https://host.atlassian.net/rest/api/2/project/1450",
          "id": "1450",
          "key": "TSTP",
          "name": "TestProject",
          "avatarUrls": {
            "48x48": "https://host.atlassian.net/secure/projectavatar?pid=1450&avatarId=20535",
            "24x24": "https://host.atlassian.net/secure/projectavatar?size=small&s=small&pid=1450&avatarId=20535",
            "16x16": "https://host.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=1450&avatarId=20535",
            "32x32": "https://host.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=1450&avatarId=20535"
          },
          "projectCategory": {
            "self": "https://host.atlassian.net/rest/api/2/projectCategory/10200",
            "id": "10200",
            "description": "Used by ABC TestProject",
            "name": "ABC TestProject"
          }
        },
        "resolutiondate": "2021-05-19T09:10:22.982+0100",
        "updated": "2021-05-19T14:40:38.903+0100",
        "description": "Details of task item will be shown here",
        "customfield_10007": [
          {
            "id": 35,
            "name": "Sprint 1 (Avengers)",
            "state": "active",
            "boardId": 1,
            "startDate": "2021-05-10T07:00:00.000Z",
            "endDate": "2021-05-21T16:30:00.000Z"
          }
        ],
        "priority": {
          "name": "Sev 2",
          "id": "4"
        },
        "status": {
          "self": "https://host.atlassian.net/rest/api/2/status/1086",
          "description": "",
          "iconUrl": "https://host.atlassian.net/images/icons/statuses/generic.png",
          "name": "Complete",
          "id": "1086",
          "statusCategory": {
            "self": "https://host.atlassian.net/rest/api/2/statuscategory/1",
            "id": 1,
            "key": "done",
            "colorName": "green",
            "name": "Done"
          }
        },
        "creator": {
          "displayName": "Bob Smith"
        },
        "customfield_14006": {
          "self": "https://host.atlassian.net/rest/api/2/customFieldOption/11734",
          "value": "Pending",
          "id": "11734"
        },
        "customfield_13710": "Some more details",
        "customfield_13702": {
          "self": "https://host.atlassian.net/rest/api/2/customFieldOption/11512",
          "value": "Not Reviewed",
          "id": "11512"
        },
        "created": "2017-12-12T11:07:34.517+0000",
        "customfield_12600": "{pullrequest={dataType=pullrequest, state=MERGED, stateCount=1}, json={\"cachedValue\":{\"errors\":[],\"summary\":{\"pullrequest\":{\"overall\":{\"count\":1,\"lastUpdated\":\"2021-05-18T16:48:41.146+0100\",\"stateCount\":1,\"state\":\"MERGED\",\"dataType\":\"pullrequest\",\"open\":false},\"byInstanceType\":{\"bitbucket\":{\"count\":1,\"name\":\"Bitbucket Cloud\"}}}}},\"isStale\":true}}"
      }
    }
  ]
}

All good to go.

I hope this was useful, I found it painful to get it to this stage with not being much (IMO) documentation and tutorials on using JQL for Jira API requests. Thank you!!

Useful JQL (Jira Query Language) Dump

Lorna Watson — Thu, 13 May 2021 22:51:03 +0000

I'm playing around with JQL to see what interesting data I can get back from Jira. I'll keep this page updates with more queries as I find them.

Overview and some useful bits:

DevProject is an example project and DP being the ID of it
DP-Avengers is a team name
summary ~ help issues that contains help in summary
labels = TechDebt issues with label TechDebt

Links:

Description	JQL
List of DevProject tasks with no assignee, open status and was last updated more than 4 weeks ago	`project = DP AND assignee is EMPTY and status = OPEN and updatedDate <= -4w`
List of DevProject issues created this week	`project = DP AND created > startOfWeek() and created < endOfWeek()`
List of DevProject issues created this year	`project = DP AND created >= startOfYear()`
List of DevProject bugs created this year	`project = DP AND created >= startOfYear() AND issuetype = Bug`
List of DevProject issues created this year and still open	`project = DP AND created >= startOfYear() AND status = open`
List of DevProject support tickets in open sprints	`project = DP AND issuetype = "Support Ticket" AND Sprint in openSprints()`
List of open DevProject issues order by oldest first	`project = DP AND status not in(Complete, Closed, Resolved, Done, Declined) ORDER BY created ASC`
List of top severity issues in DevProject for Team Avengers created since start of month	`project = DP AND priority = "Sev 1" AND "Engineering Team[Dropdown]" = DP-Avengers AND created >= startOfMonth()`
List of level 3 severity issues in DevProject since start of year	`project = DP AND priority = "Sev 3" AND created >= startOfYear()`
List of issues in current sprint in DevProject with a story point assigned order by largest value	`project = DP AND sprint in openSprints() AND "Story Points[Number]" IS NOT EMPTY ORDER BY cf[10003] DESC`
List of in progress issues in DevProject with empty assignee	`project = DP AND statusCategory = "In Progress" AND assignee IS EMPTY`

Satisfaction of ✨ clean ✨ branding

Lorna Watson — Thu, 01 Apr 2021 13:06:20 +0000

I love playing around in Canva, it's super easy to use and plenty of free and paid resources available e.g. icons, images. I saw a random post on LinkedIn a good while ago of someone's business card that had the layout you can see in the cover image, I was immediately drawn to it and thought it was really clever. I unfortunately didn't make note of the post but didn't forget it. I decided I wanted to make one of my own but not a business card, just a nice cover image for my LinkedIn profile (for now). Check of the initial version in the cover image and let me know what you think!

Have you done something similar?

Polishing your GitHub profile landing page 🧹

Lorna Watson — Mon, 29 Mar 2021 15:49:43 +0000

I've had a GitHub account since 2014 and I had no idea until now you could create a secret repo by typing your username to get a pretty nice readme on the landing page of your GitHub profile.

Why won't your website thumbnail hasn't updated when trying to share on LinkedIn

Lorna Watson — Wed, 24 Mar 2021 10:59:19 +0000

The issue is cached data. You need to purge. Go to Post inspector, copy over your website UR and hit inspect. You should now see your updated website thumbnail.

Single or multi page dev portfolio website?

Lorna Watson — Wed, 24 Mar 2021 04:19:45 +0000

I've recently (as of less than an hour ago) updated my portfolio site from being a multi-page site to a single page with the reason being I felt I didn't have enough content to warrant the extra space after a lot of thought. I then began wondering if there is an industry standard. I've seen my fair share of portfolio sites but I can't say for sure which layout I've seen most.

What are your thoughts? - Do you have a portfolio site with a few pages or single? Why is that?

Smooth scrolling to same-page element

Lorna Watson — Wed, 24 Mar 2021 04:10:00 +0000

I decided to condense my portfolio site into a single page pretty much because I felt I didn't need that much space. There are various ways, as with most things, I could have gone with but ultimately decided to go with the ngx-scroll-to package.

To begin, install the package into your project folder npm i @nicky-lenaers/ngx-scroll-to and then into the AppModule file.

import { ScrollToModule } from '@nicky-lenaers/ngx-scroll-to';

@NgModule({
  imports: [ 
    ScrollToModule.forRoot()
  ]
})

navbar.component.html

 <ul class="navbar-nav ml-auto">
      <li class="nav-item"><a class="nav-link" [ngxScrollTo]="'home'" [ngxScrollToEasing]="'easeInOutQuad'"><fa-icon [icon]="faHome"></fa-icon></a></li>
      <li class="nav-item"><a class="nav-link" [ngxScrollTo]="'about'" [ngxScrollToEasing]="'easeInOutQuad'">About</a></li>
      <li class="nav-item"><a class="nav-link" [ngxScrollTo]="'dev'" [ngxScrollToEasing]="'easeInOutQuad'">Dev</a></li>
      <li class="nav-item"><a class="nav-link" [ngxScrollTo]="'blog'" [ngxScrollToEasing]="'easeInOutQuad'">Blog</a></li>
      <li class="nav-item"><a class="nav-link" [ngxScrollTo]="'projects'" [ngxScrollToEasing]="'easeInOutQuad'">Projects</a></li>
      <li class="nav-item"><a class="nav-link" [ngxScrollTo]="'contact'" [ngxScrollToEasing]="'easeInOutQuad'">Contact</a></li>
    </ul>

about.component.html

<div id="about" #about> <!-- ✨ -->
  <div class="container">
    <div class="row"> 
      <div class="col-lg-6"> 
        <button [ngxScrollTo]="'contact'" [ngxScrollToEasing]="'easeInOutQuad'" alt="Send message">Send message</button> <!-- ✨ -->
      </div>
    </div>
  </div>
</div>

I need to play around with more setting i.e. easing, but so far enjoying it. It was simple enough to add in where needed, does the job nicely! 🤗

Rendering multiple icons in AG Grid cell

Lorna Watson — Wed, 17 Mar 2021 18:14:38 +0000

End result 🥳

Setup

I've tried to strip out any irrelevant bits. Also to note I am using the free Font Awesome icons and community edition of AG Grid.

Deployments List Component

TS

Include the new cell renderer component when setting up your col defs.

{
  field: 'DeployedBy', 
  cellRendererFramework: IconCellRendererComponent 
}

Icon Cell Renderer Component

TS

import { Component } from "@angular/core";
import { ICellRendererAngularComp } from 'ag-grid-angular';
import { IconDefinition } from '@fortawesome/fontawesome-svg-core';
import { faUsers, faCity } from '@fortawesome/free-solid-svg-icons';

@Component({
  selector: 'app-icon-cell-renderer',
  templateUrl: './icon-cell-renderer.component.html'
})
export class IconCellRendererComponent implements ICellRendererAngularComp {
  faUsers = faUsers;
  faCity = faCity;

  params: any;
  icons: IconDefinition[]; // ✨ if wanting just the 1 icon change to `IconDefinition`

  agInit(params: any): void {
    this.params = params;
    if (this.params.value === 'Teamcity') {
      this.icons = [faUsers, faCity];
    }

    return this.params.value;
  }

  refresh(): boolean {
    return false;
  }
}

HTML

I'm looking at tidying this up.

<span *ngIf="icons != null; else notSys">
  <span *ngFor="let icon of icons">
    <fa-icon [icon]="icon"></fa-icon>
  </span>
</span>
<ng-template #notSys>
  {{params.value}}
</ng-template>

Styling

@almost-black: #262626;

ag-grid-angular.ag-theme-material {
  .ag-row .ag-cell fa-icon { 
    margin-left: 2px;
    margin-right: 2px;
    color: @almost-black; 
  }
}

Deploying Node.js app with Heroku config vars

Lorna Watson — Sat, 06 Mar 2021 23:30:50 +0000

I tried to deploy my Node.js project via Heroku and got the following error message:

To see more details, I cd into the project’s directory and enter heroku logs --tail. The error is Cannot find module '../../config'.

config.js file 🧾

I have a config.js file at the project root (and is included in .gitignore so secrets not exposed!!):

var config = {};

config.baseUrl = "http://teamcity:8111/app/rest";
config.apiKey = "XXX";

module.exports = config;

Function before

My code looked like this (striped out irrelevant bits):

const axios = require('axios'),
    config = require("../../config"); // ✨

exports.getAll = (req, res) => {
    axios({
        method: "get",
        url: `${config.teamCityBaseUrl}/builds`,
        headers: { 'Authorization': config.teamCityApiKey }
    }).then(response => {
        res.send(response.data);
    }).catch(error => {
        console.log(error);
    });
};

Solution ✅

Add your new config vars in Heroku and then access them in your code like process.env.TEAM_CITY_BASE_URL.

Function after

const axios = require('axios');

exports.getAll = (req, res) => {
    axios({
        method: "get",
        url: `${process.env.TEAM_CITY_BASE_URL}/builds`,
        headers: { 'Authorization': process.env.TEAM_CITY_API_KEY}
    }).then(response => {
        res.send(response.data);
    }).catch(error => {
        console.log(error);
    });
};