Skip to content
This repository was archived by the owner on Dec 18, 2020. It is now read-only.

Commit ef635ac

Browse files
committed
Addressed comments by @lubc
1 parent 692d24d commit ef635ac

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

_posts/2020-02-10-calculate-tech-debt-using-skunk-on-github-actions.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
layout: post
33
title: "How to Calculate Tech Debt Using Skunk on GitHub Actions"
44
date: 2020-02-10 16:16:00
5-
categories: ["tech-debt"]
5+
categories: ["code-quality"]
66
author: etagwerker
77
---
88

99
In preparation for my talk at [RubyConf Australia](https://www.rubyconf.org.au/) this
10-
month, I've been working on a way to make it easy for anyone to run `skunk` on their
11-
Ruby projects. In order to do that I decided to use GitHub Actions. It's a powerful
10+
month, I've been working on a way to make it easy for anyone to run [`skunk`](https://www.fastruby.io/blog/code-quality/intruducing-skunk-stink-score-calculator.html) on
11+
their Ruby projects. In order to do that I decided to use GitHub Actions. It's a powerful
1212
service by GitHub and it's quite easy to set up.
1313

1414
This is an article about the process that I followed and how you can use it in your own
@@ -110,8 +110,8 @@ steps synchronously, from top to bottom. If you want to run `skunk` for a Rails
110110
application, you can change the last step to `skunk app/`
111111

112112
The next thing I wanted to do is run `skunk` on a pull request in order to
113-
compare the _Stink Score_ between the pull request and `master`. This will help
114-
us answer this question:
113+
compare the [_Stink Score_](https://github.com/fastruby/skunk#what-is-the-stinkscore)
114+
between the pull request and `master`. This will help us answer this question:
115115

116116
> Are we increasing or decreasing the tech debt average in our project?
117117
@@ -147,9 +147,9 @@ jobs:
147147
fi
148148
```
149149
150-
There is some `bash` _magic_ in there. The GitHub Action will do one thing if
151-
you are within the context of a pull request (compare action), and another thing
152-
if it is running a commit pushed to the `master` branch.
150+
There is some `bash` logic in there: The GitHub Action will [compare your branch vs. master](https://github.com/fastruby/skunk#comparing-one-branch-vs-another) if
151+
it is running within the context of a pull request, or [generate a tech debt report](https://github.com/fastruby/skunk#getting-a-sorted-list-of-stinkiest-files) if
152+
it is running a commit pushed to the `master` branch.
153153

154154
One last thing I had to add was a step to generate [SimpleCov](https://github.com/colszowka/simplecov)'s
155155
resultset JSON file. Skunk is most useful when it considers code coverage data.

0 commit comments

Comments
 (0)