diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 62700ab..a619a35 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -35,6 +35,11 @@ jobs: - name: Test run: make cover + - name: Upload coverage reports to Codecov + uses: codecov/codecov-action@v4 + with: + token: ${{ secrets.CODECOV_TOKEN }} + lint: name: Lint runs-on: ubuntu-latest diff --git a/.gitignore b/.gitignore index c4193ab..3bb8d19 100644 --- a/.gitignore +++ b/.gitignore @@ -46,3 +46,5 @@ liquibase.properties coverage.txt +cover.out +cover.html diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..c4d8925 --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +Stewart Boyd \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..09e676b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +This project adheres to Semantic Versioning. + + +## 1.0.0 (September 2022) + + - Enum `ProtoFmt`(`proto`) renamed to `ProtoBase64Fmt`(`proto_base64`). This is intended for SQS use only while the newly introduced `ProtoRawFmt`(`proto_raw`) is intended for most other use cases. + - Enum `ProtoSchemaFmt`(`proto_schema`) renamed to `ProtoSchemaDeprecatedFmt`(`proto_schema_deprecated`). The proto schema is deprecated because it doesn't work properly with the confluent schema registry. Use the `ProtoRawFmt` or `ProtoBase64Fmt` instead. diff --git a/Makefile b/Makefile index 4d67cb3..96bcccf 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,8 @@ REMOTE_GOLANGCI_VERSION=1.56.2 .PHONY: cover cover: - go test -v ./... -count=1 -coverprofile=coverage.txt -covermode atomic + go test -v ./... -count=1 -coverprofile=cover.out -covermode atomic && \ + go tool cover -html=cover.out -o cover.html .PHONY: lint lint: golangci-lint diff --git a/README.md b/README.md index 0e83ee1..08f309e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # zfmt -[![coverage report](https://gitlab.zgtools.net/devex/archetypes/gomods/zfmt/badges/main/coverage.svg)](https://gitlab.zgtools.net/devex/archetypes/gomods/zfmt/-/commits/main) - -[![pipeline status](https://gitlab.zgtools.net/devex/archetypes/gomods/zfmt/badges/main/pipeline.svg)](https://gitlab.zgtools.net/devex/archetypes/gomods/zfmt/-/commits/main) +[![License](https://img.shields.io/github/license/zillow/zfmt)](https://github.com/zillow/zfmt/blob/main/LICENSE) +[![GitHub Actions](https://github.com/zillow/zfmt/actions/workflows/go.yml/badge.svg)](https://github.com/zillow/zfmt/actions/workflows/go.yml) +[![Codecov](https://codecov.io/gh/zillow/zfmt/branch/main/graph/badge.svg?token=STRT8T67YP)](https://codecov.io/gh/zillow/zfmt) A go library which contains a number of useful implementations of the Formatter interface,