From 13765e0ea91a2183b12bb1b914ccbb2fd33d3dc0 Mon Sep 17 00:00:00 2001
From: containerscrew <131241415+containerscrew@users.noreply.github.com>
Date: Mon, 19 Aug 2024 10:37:20 +0200
Subject: [PATCH] Implement summarize step in build pipeline & add CHANGELOG.md

---
 .github/workflows/build.yml |   4 +
 CHANGELOG.md                | 251 ++++++++++++++++++++++++++++++++++++
 Makefile                    |   3 +
 cliff.toml                  |  28 ++++
 4 files changed, 286 insertions(+)
 create mode 100644 CHANGELOG.md
 create mode 100644 cliff.toml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 9ec395a..7f2f2ce 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -1,4 +1,5 @@
 name: Build
+
 on:
   pull_request:
   push:
@@ -19,3 +20,6 @@ jobs:
 
       - name: build
         run: go build
+      
+      - name: Summarize
+        run: chmod +x ./tftools & ./tftools summarize --compact --show-tags <demo.json
\ No newline at end of file
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..661c123
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,251 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+- Brew formula update for tftools version v0.9.0
+
+- Update docs & split pipelines
+
+
+- Rename gosec pipeline
+
+
+- Update README
+
+
+## [0.9.0] - 2024-05-06
+
+- Brew formula update for tftools version v0.8.0
+
+- Version selector in scripts/install.sh && update doc
+
+
+- Fix sudo for root user installation in scripts/install.sh
+
+
+- Update README.md
+
+
+- Update doc
+
+
+- Update usage doc
+
+
+- Update doc and script/tfsum.sh
+
+
+- Tags and change summary (#1)
+
+
+
+- Update dependencies
+
+
+- Cleanup unused dependencies
+
+
+- Merge pull request #6 from danielewood/tags-and-change-summary
+
+Add Tags and change summary
+
+- Fix github actions deprecations, gosec errors & go version 1.22
+
+
+- Changes .github actions
+
+
+- Fix .github actions
+
+
+## [0.8.0] - 2024-03-31
+
+- Brew formula update for tftools version v0.7.0
+
+- Brew formula update for tftools version v1.1.0
+
+- Add pretty JSON output
+
+
+## [0.7.0] - 2024-03-28
+
+- Brew formula update for tftools version v0.6.2
+
+- Add demo.json tfplan file for testing
+
+
+- Added JSON support
+
+
+- Fix some minor issues
+
+
+- Pin version
+
+
+- Merge pull request #5 from FireDrunk/feature/json-support
+
+JSON (Metrics) Support
+
+## [0.6.2] - 2024-01-19
+
+- Brew formula update for tftools version v0.6.1
+
+- Update doc
+
+
+- Update usage doc
+
+
+- Fix high CVE on golang.org/x/net & upgrade dependencies
+
+
+## [0.6.1] - 2023-12-23
+
+- Brew formula update for tftools version v0.6.0
+
+- Fix golangci linters & update and organize documentation
+
+
+## [0.6.0] - 2023-12-23
+
+- Brew formula update for tftools version v0.5.0
+
+- Update install doc
+
+
+- Update README
+
+
+- Add general installation script
+
+
+- Refactor installation process
+
+
+- Install variable for PROJECT name
+
+
+- Fix general installation script
+
+
+- Fix: Darwin x86 amd64 installation using general install.sh script
+
+
+- Update image logo
+
+
+- Add support for Tags and Unchanged Resources
+
+
+- Update dependencies to latest versions
+
+
+- Update icons and reorder outputs
+
+
+- Merge pull request #2 from danielewood/Support-Tag-Outputs
+
+Support tag, markdown, and compact outputs
+
+- Small updates
+
+
+- Fix go versions
+
+
+- Fixing build pipeline
+
+
+## [0.5.0] - 2023-05-25
+
+- Brew formula update for tftools version v0.4.0
+
+- Update example image
+
+
+- Fix cmd version env && refactor some code
+
+
+## [0.4.0] - 2023-05-25
+
+- Brew formula update for tftools version v0.3.0
+
+- Refactor 😎
+
+
+- Edit signs in goreleaser
+
+
+- Edit gitleaks pipeline
+
+
+## [0.3.0] - 2023-05-25
+
+- Brew formula update for tftools version v0.2.0
+
+- Fix installation scripts
+
+
+- Update install doc
+
+
+- Fix install doc
+
+
+- Update README.md
+
+
+- Update usage.md docs
+
+
+## [0.2.0] - 2023-05-24
+
+- Brew formula update for tftools version v0.1.0
+
+- Fix installation scripts + .goreleaer.yaml builds
+
+
+## [0.1.0] - 2023-05-24
+
+- Initial commit
+
+
+- Brew formula update for tftools version v0.1.0
+
+- Brew formula update for tftools version v0.1.0-test
+
+- Setting up linux installation script
+
+
+- Brew formula update for tftools version v0.2.0-test
+
+- Improve goreleaser
+
+
+- Change gpg key github action
+
+
+- Fixing linus script installation
+
+
+- Brew formula update for tftools version v0.4.0-test
+
+- Update doc + go.mod
+
+
+- Update README
+
+
+- Update documentation
+
+
+- Update docs
+
+
+- Refactor docs and cmd.version variable
+
+
+<!-- generated by git-cliff -->
diff --git a/Makefile b/Makefile
index 422a986..8ecde43 100644
--- a/Makefile
+++ b/Makefile
@@ -25,6 +25,9 @@ gosec: ## Run gosec
 update-dependencies: ## Update dependencies
 	go get -u ./...
 
+generate-changelog: ## Generate changelog using git cliff
+	git cliff --output CHANGELOG.md
+
 ##https://github.com/moovweb/gvm
 ##go get golang.org/x/tools/cmd/goimports
 ##go install golang.org/x/tools/cmd/goimports
diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 0000000..2bae838
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,28 @@
+[changelog]
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for commit in commits | unique(attribute="message") %}
+    - {{ commit.message | upper_first }}
+{% endfor %}\n
+"""
+
+footer = """
+<!-- generated by git-cliff -->
+"""
+trim = true
+
+[git]
+conventional_commits = false
+filter_unconventional = false
+split_commits = false
+tag_pattern = "^v[0-9]+\\.[0-9]+\\.[0-9]+$"
+sort_commits = "oldest"
\ No newline at end of file