Document when one would want to use --staged #244
Conversation
We don't need it as we're not checking anything besides the commit message, and using it requires user.name and user.email to be set in config, which is a minor annoyance in CI. Refs jorisroovers/gitlint#244
We don't need it as we're not checking anything besides the commit message, and using it requires user.name and user.email to be set in config, which is a minor annoyance in CI. Refs jorisroovers/gitlint#244
|
Thanks for the suggestion. I can see that I do think the sentence "Useful if checking other properties of a commit besides just the message." doesn't necessarily tell much more than the existing "Read staged commit meta-info from the local repository". I guess the word "meta-info" is where you got caught up? Maybe we should change it to: "Read staged commit meta-info (username, email, changed files, etc) from the local repository". That would also keep the |
|
To me the interesting thing is why would I want to have staged commit meta-info read from the repo. In that sense, "if checking other properties of a commit besides just the message" is to the point and helpful to me. On the other hand, the "(username, email, changed files, etc)" addition does add some detail, but leaves the question kind of open -- without having a look under the hood, I wouldn't know if gitlint needed that info for something not directly related to which properties of a commit I want to lint, or if I can leave it out. But yeah, my suggestion isn't as concise as I'd like it to be, and it feels kind of silly to repeat it everywhere. The reason I added it to both |
We don't need it as we're not checking anything besides the commit message, and using it requires user.name and user.email to be set in config, which is a minor annoyance in CI. Refs jorisroovers/gitlint#244
Includes the CLI --help command as well as the docs.
jorisroovers
force-pushed
the
staged-docs
branch
from
ae1d0ac
to
04eb592
Compare
|
Added a more lengthy explanation in the docs and updated the |
- Python 3.11 support - Last release to support Python 3.6 - Behavior Change: In a future release, gitlint will be switching to use `re.search` instead of `re.match` semantics for all rules. (#254) - gitlint no longer uses the `sh` library by default in an attempt to reduce external dependencies. - `--commits` now also accepts a comma-separated list of commit hashes, making it possible to lint a list of non-contiguous commits without invoking gitlint multiple times (#283) - Improved handling of branches that have no commits (#188) - Support for `GITLINT_CONFIG` env variable (#189) - Added a new `gitlint-ci` pre-commit hook, making it easier to run gitlint through pre-commit in CI (#191) - Contrib Rules: - New `contrib-disallow-cleanup-commits` rule (#312) - New `contrib-allowed-authors` rule (#358) - User Defined rules: - Gitlint now recognizes `fixup=amend` commits, available as `commit.is_fixup_amend_commit=True` - Gitlint now parses diff **stat** information, available in `commit.changed_files_stats` (#314) - Bugfixes: - Use correct encoding when using `--msg-filename` parameter (#310) - Various documentation fixes (#244) (#263) (#266) (#294) (#295) (#347) (#364) - Under-the-hood: - Dependencies updated - Moved to blacked for formatting - Fixed nasty CI issue (#298) - Unit tests fix (#256) - Vagrant box removed in favor of github dev containers (#348) - Removed a few lingering references to the `master` branch in favor of `main` - Moved roadmap and project planning to github projects Full Release details in CHANGELOG.md.
I was wondering why I'd need to set
user.nameanduser.emailwhen running gitlint with pre-commit in CI, and realized it's because of--stagedin the hook's default config. It wasn't immediately clear to me why I'd want--staged(turns out I don't), so I thought I'd document it.Might be nice to also document that with
--stagedone needs those git configs set, but don't know if that's too much detail on this level.