keinos / dev-go

Template to develop Go via Docker + VSCode + Remote-Containers.

Profile of KEINOS

• Name: KEINOS
• Taxonomy: Japonicus Chilangosis Mexicanus
• Details: Look deep inside KEINOS
• Open Sources: https://github.com/KEINOS @ GitHub
• Articles: https://qiita.com/KEINOS @ Qiita

Qiita Status

GitHub Status

dev-go's Issues

docs: forgotten link path in SECURITY.md

Check the below link and see the link, it is targeting to go-utils and not dev-go.

https://github.com/KEINOS/dev-go/blame/a6229ad0edab7dc894aa928350de6fdc7662a0ac/.github/SECURITY.md#L16

race option in tests

1. Set -race option in Go 1.14+'s action @ Dockerfile
   

   dev-go/.github/Dockerfile

   Line 19 in c232a95

   ENTRYPOINT go mod download && go test ./...

- ENTRYPOINT go mod download && go test ./... 
+ ENTRYPOINT go mod download && go test -race ./... 

2. Remove -race option in CodeCov action.
   

   dev-go/.github/workflows/code-coverage.yml

   Line 26 in c232a95

   run: go test -race -coverprofile=coverage.out -covermode=atomic ./...

- go test -race -coverprofile=coverage.out -covermode=atomic ./...
+ go test -coverprofile=coverage.out -covermode=atomic ./...

False-negative on test because of docker-compose up

The below weekly test fails but passes the CI.
https://github.com/KEINOS/dev-go/runs/4575637235?check_suite_focus=true#step:3:120

Cause

Using up command in docker-compose doesn't return 1 on test fail. It will return status 1 only if the container fails to boot.

$ docker-compose up tidy
...
github_tidy_1 exited with code 1
...
$ echo $?
0

Fix

• docker-compose up -> docker-compose run

      - name: Update go.mod and run tests
        run: |
          set -eu
-           docker-compose --file ./.github/docker-compose.yml up tidy && \
-           docker-compose --file ./.github/docker-compose.yml up v1_14 && \
-           docker-compose --file ./.github/docker-compose.yml up v1_15 && \
-           docker-compose --file ./.github/docker-compose.yml up v1_16 && \
-           docker-compose --file ./.github/docker-compose.yml up v1_17 && \
-           docker-compose --file ./.github/docker-compose.yml up latest
+           docker-compose --file ./.github/docker-compose.yml run tidy && \
+           docker-compose --file ./.github/docker-compose.yml run v1_14 && \
+           docker-compose --file ./.github/docker-compose.yml run v1_15 && \
+           docker-compose --file ./.github/docker-compose.yml run v1_16 && \
+           docker-compose --file ./.github/docker-compose.yml run v1_17 && \
+           docker-compose --file ./.github/docker-compose.yml run latest

actions: Workflow cron mismatches in the comment

All the below runs every week.

dev-go/.github/workflows/code-coverage.yml

Lines 10 to 11 in d0be682

	# Runs at 16:40 UTC on day-of-month 1 (Every day-of-month 1 at AM 01:40 JST, my time)
	- cron: '40 16 * * SUN'

dev-go/.github/workflows/codeQL-analysis.yml

Lines 16 to 17 in d0be682

	# Runs at 16:30 UTC on day-of-month 1 (Every day-of-month 1 at AM 01:30 JST, my time)
	- cron: '30 16 * * SUN'

dev-go/.github/workflows/go-versions.yml

Lines 7 to 8 in d0be682

	# Runs at 16:05 UTC on day-of-month 1 (Every day-of-month 1 at AM 01:05 JST, my time)
	- cron: '5 16 * * SUN'

[feat] go-releaser for Homebrew release

Implement Homebrew release using go-releaser.

"go-capturer" package has been renamed

go: github.com/KEINOS/dev-go/sample tested by
	github.com/KEINOS/dev-go/sample.test imports
	github.com/kami-zh/go-capturer: github.com/kami-zh/[email protected]: parsing go.mod:
	module declares its path as: github.com/zenizh/go-capturer
	        but was required as: github.com/kami-zh/go-capturer

• https://github.com/KEINOS/dev-go/runs/4575642555?check_suite_focus=true#step:4:17

-  github.com/kami-zh/go-capturer
+  github.com/zenizh/go-capturer

actions: redundant test on workflow

go-test.yml workflow runs the same command between Windows and non-Windows platforms. These run steps can be as one.

dev-go/.github/workflows/go-test.yml

Lines 38 to 48 in f347a78

	- name: Run coverage (Windows)
	if: runner.os == 'Windows'
	run: |
	go mod download
	go test -v ./...
	- name: Run coverage (Linux/macOS)
	if: runner.os != 'Windows'
	run: |
	go mod download
	go test -v ./...