Archives/git-filter-repo
2
0
Fork 0
mirror of https://github.com/newren/git-filter-repo.git synced 2024-11-19 03:25:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
9d51a90648
git-filter-repo/contrib/filter-repo-demos
History
Elijah Newren dab9386c47 contrib: update bfg-ish and filter-lamely with windows workaround 
In commit f2729153 (filter-repo: workaround Windows' insistence that cwd
not be a bytestring, 2019-10-19), filter-repo was made to use a special
SubprocessWrapper class instead of the normal subprocess calls, due to
what appears to be in bugs in the python implementation on Windows not
working with arguments being bytestrings.  Add the same workarounds to
bfg-ish and filter-lamely.

Signed-off-by: Elijah Newren <newren@gmail.com>
2019-12-26 15:54:47 -08:00
..
bfg-ish contrib: update bfg-ish and filter-lamely with windows workaround 2019-12-26 15:54:47 -08:00
clean-ignore contrib: simple examples of tools based on filter-repo 2019-08-13 14:25:29 -07:00
filter-branch-ish contrib: new filter-repo demo named filter-lamely (or filter-branch-ish) 2019-08-20 23:58:47 -07:00
filter-lamely contrib: update bfg-ish and filter-lamely with windows workaround 2019-12-26 15:54:47 -08:00
insert-beginning contrib: clarify a few points of usage 2019-11-25 08:42:29 -08:00
lint-history contrib: simple examples of tools based on filter-repo 2019-08-13 14:25:29 -07:00
README.md contrib: new filter-repo demo named bfg-ish 2019-08-20 23:58:47 -07:00
signed-off-by filter-repo: improve support for partial history rewrites 2019-10-17 18:55:09 -07:00

README.md

Background

filter-repo is not merely a history rewriting tool, it also contains a library that can be used to write new history rewriting tools. This directory contains several examples showing the breadth of different things that could be done.

Quick overview

Command                         Description
insert-beginning Add a new file (e.g. LICENSE/COPYING) to the beginning of history.
signed-off-by Add a Signed-off-by tag to a range of commits
lint-history Run some lint command on all non-binary files in history.
clean-ignore Delete files from history which match current gitignore rules.
filter-lamely (or filter‑branch‑ish) A nearly bug compatible re-implementation of filter-branch (the git testsuite passes using it instead of filter-branch), with some performance tricks to make it several times faster (though it's still glacially slow compared to filter-repo).
bfg-ish A re-implementation of most of BFG Repo Cleaner, with new features and bug fixes.

Purpose

Please note that the point of these examples is not to provide new complete tools, but simply to demonstrate that extremely varied history rewriting tools can be created which automatically inherit lots of useful base functionality: rewriting hashes in commit messages, pruning commits that become empty, handling filenames with funny characters, non-standard encodings, handling of replace refs, etc. (Additional examples of using filter-repo as a library can also be found in the testsuite.) My sincerest hope is that these examples provide lots of useful functionality, but that each is missing at least one critical piece for your usecase. Go forth and extend and improve.

Usage

All the examples require a symlink to git-filter-repo in your PYTHONPATH named git_filter_repo.py in order to run; also, all have a --help flag to get a description of their usage and flags.