https://github.com/seankilleen/tf-whatsup

Highlights Terraform provider release notes you should care about.
https://github.com/seankilleen/tf-whatsup

dotnet dotnet-core spectre-console terraform

Last synced: 3 months ago
JSON representation

Highlights Terraform provider release notes you should care about.

• Host: GitHub
• URL: https://github.com/seankilleen/tf-whatsup
• Owner: SeanKilleen
• License: mit
• Created: 2022-11-19T05:07:25.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-02T10:18:04.000Z (over 1 year ago)
• Last Synced: 2024-10-11T01:52:11.622Z (4 months ago)
• Topics: dotnet, dotnet-core, spectre-console, terraform
• Language: C#
• Homepage:
• Size: 113 KB
• Stars: 10
• Watchers: 3
• Forks: 1
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tf-whatsup

_[![NuGet version](https://img.shields.io/nuget/v/TFWhatsUp.Console.svg?style=flat&label=nuget%3A%20TFWhatsUp.Console)](https://www.nuget.org/packages/TFWhatsUp.Console)_

_[![Build Process](https://github.com/SeanKilleen/tf-whatsup/actions/workflows/build-process.yml/badge.svg)](https://github.com/SeanKilleen/tf-whatsup/actions/workflows/build-process.yml)_

Highlights Terraform provider release notes you should care about.

[![ASCII console animation of the tool in action](https://asciinema.org/a/mUou4fBy6cN3SuRTXmfcaAhev.svg)](https://asciinema.org/a/mUou4fBy6cN3SuRTXmfcaAhev)

## Usage

```cmd

USAGE:

    TFWhatsUp.Console.dll [tfFilesPath] [OPTIONS]

ARGUMENTS:

    [tfFilesPath]    Path where your Terraform is located. Defaults to current directory

OPTIONS:

    -h, --help                Prints help information

    -t, --github-api-token    A GitHub Personal Access Token. If you generate one and pass it, you won't hit the smaller rate-limits of un-authenticated accounts

    -a, --all                 Typically we show one provider information at a time. This will show all of them without pause

    -c, --caps                Instead of highlighting text, will show it in all caps with a '***' indicator at the start of a line

```

## The Use Case

I sometimes look at Terraform projects with providers that haven't been updated in a bit, especially because it's a good practice to peg a provider at a specific version. I want to upgrade them incrementally or perhaps in a large chunk, but it's not immediately clear which of the many, lovely, detailed Terraform notes across providers will actually apply to me (this is especially true in projects I'm parachuting into). This tool takes care of a lot of that work and helps me find the signal in the noise.

## Current Status

This is usable. I'll probably start putting it out there and seeing what I get. It still needs some tests of course but I'm able to use it in my daily work.

If it seems to work for folks for a while, I'll bump it to `v1.0.0`.

## The Gist

* Finds Terraform files

* Uses [`Octopus.CoreParsers.Hcl`](https://github.com/OctopusDeploy/HCLParser) to parse the file and pull the provider information

* Uses `HttpClient` to hit the Terraform Provider API URL in order to obtain the GitHub URL

* Uses [`Octokit`](https://github.com/octokit/octokit.net) to find the release that matches yours

* Pulls all releases & Filters them to those published after yours (both date-wise and based on Semver thanks to [`Semver'](https://github.com/maxhauser/semver))

* Orders the release notes earliest to latest for a given provider

* Prints the release notes line-by-line, highlighting the ones you might care about.