valkyrjaio / ci-golangcilint-go / 30783285244
100%

DEFAULT BRANCH: 26.x
Ran
Jobs 1
Files 4
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 100.0%. Remained the same
30783285244

push

github

web-flow 
[Lint] fix: Surface a generator failure from the configuration check (#5)

# Description

`config-check` pipes the generator into `diff`:

```make
@$(VALKYRJALINT) config | diff -u .golangci.yml - \
	|| { echo 'FAIL  .golangci.yml is stale. Run: make config-write'; exit 1; }
```

`make` runs a recipe under `/bin/sh`, and this `Makefile` sets no
`SHELL` and no
`.SHELLFLAGS`, so there is no `pipefail`. A pipeline reports the status
of its
last command, which is `diff`. A generator that fails writes nothing to
stdout,
`diff` then reports the whole committed file as removed, and the recipe
reports
a stale file.

The reader is told to run `make config-write`, and the real failure
appears only
as incidental stderr.

The recipe now writes the output to a temporary file first. The
generator's own
status ends the recipe, so its stderr and its exit code are what the
reader
sees. `mktemp` with a `trap` keeps two runs from colliding and leaves
nothing
behind.

## Verification

With a generator that writes `boom` to stderr and exits 3:

- Before: `FAIL .golangci.yml is stale. Run: make config-write`, status
1.
- After: `boom`, then `make: *** [config-check] Error 3`.

`make ci` still passes, with statement coverage at 100.0%.

valkyrjaio/project-template-go#45 carries the same fix. A review of that
pull
request found this, and the same recipe had already been copied here.

## Types of changes

- [ ] Improvement _(non-breaking change which improves code)_
- [x] Bug fix _(non-breaking change which fixes an issue)_
- [ ] New feature _(non-breaking change which adds functionality)_
- [ ] Deprecation _(breaking change which removes functionality)_
- [ ] Breaking change _(fix or feature that would cause existing
functionality to change)_
- [ ] Documentation improvement

## Changes

- **`Makefile`** — `config-check` writes the generated configuration to
a
temporary file instead of piping it into `diff`, so a generator failure
ends
  the recipe with its own status. Added ... (continued)

158 of 158 relevant lines covered (100.0%)

7.63 hits per line

Jobs
ID Job ID Ran Files Coverage
1 30783285244.1 4
100.0
 GitHub Action Run
Source Files on build 30783285244