sds / overcommit / 41935456288
92%
master: 91%

LAST BUILD BRANCH: main
DEFAULT BRANCH: master
Ran
Jobs 8
Files 223
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: 92.031%. Remained the same
41935456288

push

github

web-flow 
Read .overcommit.yml as UTF-8 in the hook template (#910)

Fixes #868.

Every hook in `template-dir/hooks` starts by reading `.overcommit.yml`
to look for a `gemfile:` setting:

```ruby
File.read('.overcommit.yml') =~ /gemfile: (?:false|['"]?(.*)['"]?)/
```

`File.read` without an encoding uses `Encoding.default_external`. Under
a non-UTF-8 locale such as `LANG=C` that is US-ASCII, so if
`.overcommit.yml` contains any non-ASCII character (even in a comment)
the match raises `ArgumentError: invalid byte sequence in US-ASCII`
before Overcommit loads, and every git hook fails.

This passes `encoding: 'UTF-8'` in all 10 hook copies (the template
directory spec requires them to be byte-identical).

The regression spec in `spec/integration/template_dir_spec.rb`
initializes a temporary repository using the hook templates and writes a
`.overcommit.yml` containing a non-ASCII comment. It runs the installed
`pre-commit` hook with `LC_ALL=C LANG=C` and `-E US-ASCII`, then checks
for a successful exit and output from the configured `AuthorName` check.
This verifies that the hook actually runs instead of passing on an
unrelated startup failure or an early exit. The encoding is set
explicitly because the CI runners use a UTF-8 locale by default.

Initial validation of the original spec on the fork:

- Spec only, without the fix:
[Tests](https://github.com/ChandraChaan/overcommit/actions/runs/41726596528)
fails on every Ruby from 2.6 to 4.0 with a single failure out of 1667
examples, `template_dir_spec.rb:31`, `expected
"…/template-dir/hooks/pre-commit:30:in '<main>': invalid byte s…" not to
include "invalid byte sequence"`.
- Spec with the fix:
[Tests](https://github.com/ChandraChaan/overcommit/actions/runs/41726604340)
passes on all eight Ruby versions (`1667 examples, 0 failures`), and
Lint passes.

The original fix commit is the squashed form of the fix branch; a
separate follow-up commit strengthens the regression test. I left
`CHANGELOG.md` alone since it look... (continued)

3326 of 3614 relevant lines covered (92.03%)

3269.75 hits per line

Jobs
ID Job ID Ran Files Coverage
1 ruby3.2-ubuntu - 41935456288.1 446
91.94
GitHub Action Run
2 ruby3.0-ubuntu - 41935456288.2 446
91.97
GitHub Action Run
3 ruby3.1-ubuntu - 41935456288.3 446
91.94
GitHub Action Run
4 ruby3.3-ubuntu - 41935456288.4 446
91.99
GitHub Action Run
5 ruby3.4-ubuntu - 41935456288.5 446
92.0
GitHub Action Run
6 ruby2.7-ubuntu - 41935456288.6 446
91.97
GitHub Action Run
7 ruby4.0-ubuntu - 41935456288.7 446
92.0
GitHub Action Run
8 ruby2.6-ubuntu - 41935456288.8 446
91.97
GitHub Action Run
Source Files on build 41935456288