feat: Add a Changelog

.chglog/CHANGELOG.tpl.md

@@ -0,0 +1,66 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+{{ if .Versions -}}
+<a name="unreleased"></a>
+## [Unreleased]
+
+{{ if .Unreleased.CommitGroups -}}
+{{ range .Unreleased.CommitGroups -}}
+### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+{{ range .Versions }}
+<a name="{{ .Tag.Name }}"></a>
+## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
+{{ range .CommitGroups -}}
+### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+
+{{- if .RevertCommits -}}
+### Reverts
+{{ range .RevertCommits -}}
+- {{ .Revert.Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .MergeCommits -}}
+### Pull Requests
+{{ range .MergeCommits -}}
+- {{ .Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+{{ range .Notes }}
+{{ .Body }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+{{- if .Versions }}
+[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
+{{ range .Versions -}}
+{{ if .Tag.Previous -}}
+[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+_______________________
+
+CHANGELOG.md is generated with [git-chlog](https://github.com/git-chglog/git-chglog)

.chglog/config.yml

@@ -0,0 +1,28 @@
+---
+style: github
+template: CHANGELOG.tpl.md
+info:
+  title: CHANGELOG
+  repository_url: https://github.com/PrivateBin/helm-chart
+options:
+  commits:
+  # filters:
+  #   Type:
+  #     - feat
+  #     - fix
+  #     - perf
+  #     - refactor
+  commit_groups:
+  # title_maps:
+  #   feat: Features
+  #   fix: Bug Fixes
+  #   perf: Performance Improvements
+  #   refactor: Code Refactoring
+  header:
+    pattern: "^(\\w*)\\:\\s(.*)$"
+    pattern_maps:
+      - Type
+      - Subject
+  notes:
+    keywords:
+      - BREAKING CHANGE

.github/workflows/changelog.yaml

@@ -0,0 +1,57 @@
+---
+name: Create changelog
+on: 
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+    branches:
+      - master
+      - main
+
+jobs:
+  generate_changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Get chart version
+        id: get_chart_version
+        uses: mikefarah/yq@v4.21.1
+        with:
+          cmd: yq '.version' 'charts/privatebin/Chart.yaml'
+      - name: Generate PR changelog
+        id: gen_pr_changelog
+        uses: bdashrad/git-chglog-action@v2.0.3
+        with:
+          next_version: privatebin-${{ steps.get_chart_version.outputs.result }}
+          tag: privatebin-${{ steps.get_chart_version.outputs.result }}
+      - name: Generate full changelog
+        id: gen_changelog
+        uses: bdashrad/git-chglog-action@v2.0.3
+        with:
+          next_version: privatebin-${{ steps.get_chart_version.outputs.result }}
+          filename: CHANGELOG.md
+      - name: Diff CHANGELOG.md
+        id: diff_changelog
+        run: scripts/diff-changelog.sh
+      - name: Comment PR
+        uses: mshick/add-pr-comment@v1
+        with:
+          message: |
+            ${{ steps.gen_pr_changelog.outputs.changelog }}
+            <details>
+              <summary>Full Changelog diff (Click to Expand)</summary>
+
+            ```diff
+            ${{ steps.diff_changelog.outputs.diff }}
+            ```
+            </details>
+          allow-repeats: false
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+        if: |
+          github.event_name == 'pull_request' &&
+          steps.gen_changelog.outputs.changelog != ''

.github/workflows/lint-pr.yaml

@@ -0,0 +1,22 @@
+---
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+  pull_request:
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          validateSingleCommit: true
+          validateSingleCommitMatchesPrTitle: true

.github/workflows/release.yaml

@@ -8,6 +8,32 @@ on:
       - master
 
 jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Get chart version
+        id: get_chart_version
+        uses: mikefarah/yq@v4.21.1
+        with:
+          cmd: yq '.version' 'charts/privatebin/Chart.yaml'
+      - name: Generate changelog
+        id: gen_changelog
+        uses: bdashrad/git-chglog-action@v2.0.3
+        with:
+          next_version: privatebin-${{ steps.get_chart_version.outputs.result }}
+          filename: CHANGELOG.md
+      - name: Commit CHANGELOG.md
+        uses: EndBug/add-and-commit@v8
+        with:
+          add: CHANGELOG.md
+          default_author: github_actor
+          message: 'Update CHANGELOG.md for version ${{ steps.get_chart_version.outputs.result }}'
+          push: true
+
   release:
     runs-on: ubuntu-latest
     steps:
@@ -41,3 +67,23 @@ jobs:
           charts_dir: charts
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Get chart version
+        id: get_chart_version
+        uses: mikefarah/yq@v4.21.1
+        with:
+          cmd: yq '.version' 'charts/privatebin/Chart.yaml'
+
+      - name: Generate changelog for release
+        id: gen_changelog
+        uses: bdashrad/git-chglog-action@v2.0.3
+        with:
+          tag: privatebin-${{ steps.get_chart_version.outputs.result }}
+
+      - name: Update Release
+        uses: ncipollo/release-action@v1
+        with:
+          allowUpdates: true
+          body: ${{ steps.changelog_reader.outputs.changes }}
+          tag: ${{matrix.tag}}
+          token: ${{ secrets.GITHUB_TOKEN }}