elesto-dao / elesto

The ElestoDAO node
Apache License 2.0
4 stars 1 forks source link

conventional commits for docs don't seem to be working #218

Open barriebyron opened 1 year ago

barriebyron commented 1 year ago

Let's test the conventional commits rules in CI

I am not able to successfully use the following commit messages, which I think should be valid:

git commit -m "fix(docs): edits for whitepaper consistency, vocabulary, grammar"
git commit -m “fix(docs): update technical setup for first use”
git commit -m “feat(docs): add glossary list of terms”

Reach out to me and I'll help test when we are ready to verify the CI integration for conventional commits in regard to documentation commits.

barriebyron commented 1 year ago

@noandrea this is what @glebiller and I witnessed (saw it again today!), I am now working around the issue by using the --no-verify flag

➜  elesto git:(add-code-of-conduct-1) ✗ git commit -m "fix(docs): remove CoC from contributing because now isolated in CoC file"
[INFO] Initializing environment for https://github.com/golangci/golangci-lint.
[INFO] Installing environment for https://github.com/golangci/golangci-lint.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
golangci-lint........................................(no files to check)Skipped
golangci-lint........................................(no files to check)Skipped
Conventional Commit......................................................Failed
- hook id: conventional-pre-commit
- exit code: 1

grep: invalid option -- P
usage: grep [-abcdDEFGHhIiJLlMmnOopqRSsUVvwXxZz] [-A num] [-B num] [-C[num]]
    [-e pattern] [-f file] [--binary-files=value] [--color=when]
    [--context[=num]] [--directories=action] [--label] [--line-buffered]
    [--null] [pattern] [file ...]
[Commit message] fix(docs): remove CoC from contributing because now isolated in CoC file

Your commit message does not follow Conventional Commits formatting
https://www.conventionalcommits.org/

Conventional Commits start with one of the below types, followed by a colon,
followed by the commit message:

    build chore ci docs feat fix perf refactor revert style test

Example commit message adding a feature:

    feat: implement new API

Example commit message fixing an issue:

    fix: remove infinite loop

Optionally, include a scope in parentheses after the type for more context:

    fix(account): remove infinite loop
github-actions[bot] commented 1 year ago

This issue was marked as stale because there was no activity for 15 days