Merge pull request #1 from psturc/RHTAP-1851

feat: make it suitable for openshift-ci
psturc · Nov 2, 2023 · 4e2b175 · 4e2b175
2 parents f58d89e + b8c8972
commit 4e2b175
Show file tree

Hide file tree

Showing 22 changed files with 333 additions and 554 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,32 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "feat"
+      include: "scope"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      time: "08:00"
+    labels:
+      - "dependencies"
+    commit-message:
+      prefix: "feat"
+      include: "scope"
diff --git a/.github/workflows/goreleaser.yml b/.github/workflows/goreleaser.yml
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,25 @@
+name: golangci-lint
+on:
+  push:
+    paths:
+      - '**.go'
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.19'
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.55.1
+          args: -v --timeout=5m
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+junit2html
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
diff --git a/Formula/junit2html.rb b/Formula/junit2html.rb
diff --git a/Makefile b/Makefile
@@ -0,0 +1,17 @@
+projectname?=junit2html
+
+export GOFLAGS := -mod=mod
+
+default: help
+
+.PHONY: help
+help: ## list makefile targets
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: build
+build: ## build golang binary
+	@go build -ldflags "-X main.version=$(shell git describe --abbrev=0 --tags --always)" -o $(projectname)
+
+.PHONY: install
+install: ## install golang binary
+	@go install -ldflags "-X main.version=$(shell git describe --abbrev=0 --tags --always)"
diff --git a/README.md b/README.md
@@ -11,43 +11,15 @@ Convert Junit XML reports (`junit.xml`) into HTML reports using a single standal
 
 ![screenshot](screenshot.png)
 
-## Install
-
-Like `jq`, `junit2html` is a tiny (8Mb) standalone binary. You can download it from the [releases page](https://github.com/kitproj/junit2html/releases/latest).
-
-If you're on MacOS, you can use `brew`:
-
-```bash
-brew tap kitproj/junit2html --custom-remote https://github.com/kitproj/junit2html
-brew install junit2html
-```
-
-Otherwise, you can use `curl`:
-
-```bash
-curl -q https://raw.githubusercontent.com/kitproj/junit2html/main/install.sh | sh
-```
-
 ## Usage
 
-Here is an example that uses trap to always created the test report:
+### Build
 
 ```bash
-go install github.com/alexec/junit2html@latest
-
-trap 'go-junit-report < test.out > junit.xml && junit2html < junit.xml > test-report.html' EXIT
-
-go test -v -cover ./... 2>&1 > test.out
+make build
 ```
 
-💡 Don't use pipes (i.e. `|`) in shell, pipes swallow exit codes. Use `<` and `>` which is POSIX compliant.
-
-## Test
-
-How to test this locally:
-
+### Run
 ```bash
-go test -v -cover ./... 2>&1 > test.out
-go-junit-report < test.out > junit.xml 
-go run . < junit.xml > test-report.html 
-```
+./junit2html < <junit-file.xml> > <output-report.html>
+```
diff --git a/example/coverage/coverage.go b/example/coverage/coverage.go
diff --git a/example/coverage/coverage_test.go b/example/coverage/coverage_test.go
diff --git a/example/example.go b/example/example.go
diff --git a/example/example_test.go b/example/example_test.go
diff --git a/go.mod b/go.mod
@@ -1,5 +1,5 @@
-module github.com/alexec/junit2html
+module github.com/redhat-appstudio-qe/junit2html
 
-go 1.18
+go 1.19
 
-require github.com/jstemmer/go-junit-report v1.0.0
+require github.com/jstemmer/go-junit-report/v2 v2.0.0
diff --git a/go.sum b/go.sum
@@ -1,2 +1,4 @@
-github.com/jstemmer/go-junit-report v1.0.0 h1:8X1gzZpR+nVQLAht+L/foqOeX2l9DTZoaIPbEQHxsds=
-github.com/jstemmer/go-junit-report v1.0.0/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/XSXhF0NWZEnDohbsk=
+github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
+github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/jstemmer/go-junit-report/v2 v2.0.0 h1:bMZNO9B16VFn07tKyi4YJFIbZtVmJaa5Xakv9dcwK58=
+github.com/jstemmer/go-junit-report/v2 v2.0.0/go.mod h1:mgHVr7VUo5Tn8OLVr1cKnLuEy0M92wdRntM99h7RkgQ=
diff --git a/install.sh b/install.sh