Add changie and go-releaser (#3)

.changes/0.1.0.md

@@ -0,0 +1,5 @@
+## 0.1.0 - 2023-12-19
+
+### Added
+
+* Initial version

.changes/header.tpl.md

@@ -0,0 +1,7 @@
+# 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/),
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
+and is generated by [Changie](https://github.com/miniscruff/changie).

.changie.yaml

@@ -0,0 +1,29 @@
+changesDir: .changes
+unreleasedDir: unreleased
+headerPath: header.tpl.md
+changelogPath: CHANGELOG.md
+versionExt: md
+versionFormat: '## {{.VersionNoPrefix}} - {{.Time.Format "2006-01-02"}}'
+kindFormat: '### {{.Kind}}'
+changeFormat: '* {{.Body}}'
+kinds:
+- label: Added
+  auto: minor
+- label: Changed
+  auto: major
+- label: Deprecated
+  auto: minor
+- label: Removed
+  auto: major
+- label: Fixed
+  auto: patch
+- label: Security
+  auto: patch
+newlines:
+  afterChangelogHeader: 0
+  beforeKind: 1
+  afterKind: 1
+  afterChangelogVersion: 0
+  beforeChangelogVersion: 1
+  endOfVersion: 1
+envPrefix: CHANGIE_

.github/workflows/goreleaser.yml

@@ -0,0 +1,32 @@
+# .github/workflows/release.yml
+name: goreleaser
+
+on:
+  push:
+    # run only semantic versioning tags
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+  # packages: write
+  # issues: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - run: git fetch --force --tags
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      - uses: goreleaser/goreleaser-action@v5
+        with:
+          distribution: goreleaser
+          version: latest
+          args: release --clean --release-notes .changes/${{ github.ref_name }}.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.goreleaser.yaml

@@ -0,0 +1,49 @@
+# This is an example .goreleaser.yml file with some sensible defaults.
+# Make sure to check the documentation at https://goreleaser.com
+
+# The lines below are called `modelines`. See `:help modeline`
+# Feel free to remove those if you don't want/need to use them.
+# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+# vim: set ts=2 sw=2 tw=0 fo=cnqoj
+
+version: 1
+
+before:
+  hooks:
+    # You may remove this if you don't use go modules.
+    - go mod tidy
+    # you may remove this if you don't need go generate
+    - go generate ./...
+
+builds:
+  - env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+      - windows
+      - darwin
+    main: ./cmd/go-homebank-csv/main.go
+    binary: go-homebank-csv
+
+
+archives:
+  - format: tar.gz
+    # this name template makes the OS and Arch compatible with the results of `uname`.
+    name_template: >-
+      {{ .ProjectName }}_
+      {{- title .Os }}_
+      {{- if eq .Arch "amd64" }}x86_64
+      {{- else if eq .Arch "386" }}i386
+      {{- else }}{{ .Arch }}{{ end }}
+      {{- if .Arm }}v{{ .Arm }}{{ end }}
+    # use zip for windows archives
+    format_overrides:
+      - goos: windows
+        format: zip
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"

CHANGELOG.md

@@ -0,0 +1,13 @@
+# 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/),
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
+and is generated by [Changie](https://github.com/miniscruff/changie).
+
+## 0.1.0 - 2023-12-19
+
+### Added
+
+* Initial version

README.md

@@ -14,26 +14,14 @@ HomeBank is a crossplatform free and easy accounting software.
 ## Supported formats
 
 * MoneyWallet
+  * [MoneyWallet](https://f-droid.org/en/packages/com.oriondev.moneywallet) is an expense manager for Android.
+go-homebank-csv supports parsing and converting the CSV export format.
 * Barclaycard
+  * Not exactly CSV, this is the excel export format of Barclays VISA card as found on [www.barclays.de](https://www.barclays.de).
 * Volksbank
+  * This is the CSV export format used by a German Volksbank. Most probably all Volksbanks have the same format.
 * Comdirect
-
-### MoneyWallet
-
-[MoneyWallet](https://f-droid.org/en/packages/com.oriondev.moneywallet) is an expense manager for Android.
-go-homebank-csv supports parsing and converting the CSV export format.
-
-### Barclaycard
-
-This is the excel export format of Barclays VISA card as found on [www.barclays.de](https://www.barclays.de).
-
-### Volksbank
-
-This is the CSV export format used by a German Volksbank. Most probably Volksbanks have the same format.
-
-### Comdirect
-
-This is the giro account CSV export format used by [www.comdirect.de](https://www.comdirect.de).
+  * This is the giro account CSV export format used by [www.comdirect.de](https://www.comdirect.de).
 It has some weird encoding and the internal structure changes often.
 
 ## Usage
@@ -193,3 +181,56 @@ make doc-serve
 ```
 
 It starts a server in the foreground and opens a webbrowser.
+
+### Start with a new change
+
+Call `changie new`:
+
+```shell
+changie new
+```
+
+This will ask for the kind of change and create a new file in `./changes/unreleased`.
+
+### Create new release
+
+The release process consists of the following steps:
+
+1. Create changelog locally
+2. Test goreleaser locally
+3. Tag the release locally and trigger goreleaser on Github CI
+
+#### Create changelog locally
+
+`changie batch` collects unreleased changes info from `./changes/unreleased` and creates a
+new version file like `./changes/v1.2.3.md`.
+
+`changie merge` collects version files from the `./changes` folder and updates `CHANGELOG.md`.
+
+Change `minor`to the type of change:
+
+```shell
+changie batch minor
+changie merge
+```
+You may want to call the changie commands with the `--dry-run` to preview the changelog.
+
+Don't forget to commit the changes so that the workspace is clean:
+
+```shell
+git add .
+git commit -m "Prepare release $(changie latest)"
+```
+
+#### Test goreleaser locally
+
+```shell
+goreleaser release --snapshot --clean --release-notes .changes/$(changie latest).md
+```
+
+#### Tag the release locally and trigger goreleaser on Github CI
+
+```shell
+git tag $(changie latest)
+git push origin main && git push --tags
+```