Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mogensen/helm-changelog
Create changelogs for Helm Charts, based on git history
https://github.com/mogensen/helm-changelog
Last synced: 3 months ago
JSON representation
Create changelogs for Helm Charts, based on git history
- Host: GitHub
- URL: https://github.com/mogensen/helm-changelog
- Owner: mogensen
- License: apache-2.0
- Created: 2021-04-05T15:37:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T09:17:38.000Z (7 months ago)
- Last Synced: 2024-06-19T01:56:11.765Z (5 months ago)
- Language: Go
- Size: 1.98 MB
- Stars: 40
- Watchers: 4
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# helm-changelog
[](https://actions-badge.atrox.dev/mogensen/helm-changelog/goto?ref=main)
[](https://goreportcard.com/report/github.com/mogensen/helm-changelog)
Create changelogs for Helm Charts, based on git history.
The application depends on the assumption that the helm chart is released on the first commit where the version number is bumped in the `Chart.yaml` file.
All sub-sequent commits are grouped as commits for the next release, until the version number is bumped again.
## Features
The changelog contains the following things:
- Commits are grouped by releases
- Each release displays
* Supported Helm version
* Release date
* App Version for the chart
* Supported Kubernetes version
- Changes in default helm values
## Examples
This repository contains a set of example changelogs created for the github.com/prometheus-community/helm-charts charts.
- [examples](https://github.com/mogensen/helm-changelog/tree/main/examples/)
## Installation
All relevant commands are added to the `Makefile`
```bash
$ make help
Usage:
make
Targets:
help Display this help
test-unit Run unit-tests
test-integration Run integration-tests
build Build binary
verify tests and builds
image build docker image
clean clean up created files
all Runs test, build and docker
test-coverage Generate test coverage report
lint Generate static analysis report
update-docs Upgrade automatic documentations
```
### Run Standalone
First build the standalone binary:
```bash
$ make build
go build -o ./bin/helm-changelog .
```
This results in a binary in `./bin/helm-changelog`.
```bash
# See all cli options
$ ./bin/helm-changelog --help
Create changelogs for Helm Charts, based on git history
Usage:
helm-changelog [flags]
Flags:
-h, --help help for helm-changelog
-v, --verbosity string Log level (debug, info, warn, error, fatal, panic (default "warning")
# Run helm-changelog creator with default params
$ ./bin/helm-changelog
```
### Run in Docker
The helm-changelog can alternatively be run in docker.
This is done in a multi-stage build, and does not require a working go development environment.
```bash
# Building the application and docker image
$ make image
# Run the resulting docker image
$ docker run -it --rm -v $(pwd):/data mogensen/helm-changelog:latest
```
The helm-changelog app is running as a non-root user.
This is a security best-practice. If user `1000` does not have write access to the chart directory, you may need to run the container as an other user.
```bash
# Run docker image as current user
$ docker run --user $UID it --rm -v $(pwd):/data mogensen/helm-changelog:latest
```
---
## Testing
### Running Unit Tests
Unit tests are implemented with Go's standard test framework.
All tests are located in their own test-packages, enforcing that the tests only test the
public interface of the go packages.
```bash
# Run unit tests and code coverage, including test for race conditions
$ make test-coverage
```