Feature request: exclude specific commits when calculating the 'last update' calculation about mkdocs-git-revision-date-localized-plugin

[timvink]

That would be a nice addition. I'd prefer to this outside of the plugin if possible.

For example, for git-authors the main command it git blame, and there you have the option to specify a file with commit hashes to ignore (see timvink/mkdocs-git-authors-plugin#71) for details.

Preferably I would like a similar approach for this plugin (which uses git log, see below). A quick glance at the docs for git log show this isn't possible.

mkdocs-git-revision-date-localized-plugin/mkdocs_git_revision_date_localized_plugin/util.py

Lines 131 to 134 in 6150fad

	# Latest commit touching a specific file
	commit_timestamp = git.log(
	realpath, date="unix", format="%at", n=1, no_show_signature=True
	)

Do you already have a specific approach in mind?

[timvink]

The --exclude parameter (https://git-scm.com/docs/git-log#Documentation/git-log.txt---excludeltglob-patterngt) seems promising

Going through this blogpost, it seems we could add a .git-log-exclude to the root of a project, container a list of commit hashes.

Update: from the blogpost, it also requires setting a global or local git config option (something like git config log.exclude .git-log-exclude). That's something to be aware of when collaborating with a team on documentation, or when setting up your CI/CD build.

If that works, we would only need to update the documentation with an additional 'how to' page.

[markszabo]

Thanks for the quick reply! I played around with the options (including the one you suggested), but didn't find anything that would work. The closest I could get is to exclude certain commits by commit message, but even this requires cli parameters and doesn't seem to be configurable via the git config:

git log --oneline --invert-grep --grep='Update team name' docs/index.md

Meanwhile my colleague implemented this feature and will send a PR after testing it.