Skip to content

Commit d9e180d

Browse files
committed
Update README.md
1 parent 6aee02e commit d9e180d

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# git-post-commit-dummy
22

3-
A Git `post-commit` hook that keeps your GitHub commit graph intact.
3+
A Git `post-commit` hook that keeps your GitHub (or other) commit graph intact.
44

5-
Saves all commits to non-owned repositories to your own repository as dummy commit (commit without changes), so you don't lose the commits when removed from the project or organization.
5+
Saves all commits to non-owned repositories to your own repository as dummy
6+
commit (commit without changes), so you don't lose the commits when removed from
7+
the project or organization.
68

79
Dummy commit messages have the following format:
810

@@ -14,13 +16,17 @@ https://url-to-non-owned-repository
1416

1517
## Installation
1618

17-
1. Create a new repository (e.g. `git-history`) that will be used as dummy commit target
19+
1. Create a new repository (e.g. `git-history`) that will be used as dummy
20+
commit target
1821
2. Clone the repository to your local machine and note its path
19-
3. Download [post-commit](post-commit) and set `GITHUB_ACCOUNT_URL` and `DUMMY_COMMIT_REPOSITORY`
22+
3. Download [post-commit](post-commit) and set `OWNED_REMOTE_URL_PREFIX` and
23+
`DUMMY_COMMIT_REPOSITORY_PATH`
2024
4. Make `post-commit` executable by running `chmod +x post-commit`
21-
5. Copy `post-commit` to a project's `.git/hooks` directory to have it save dummy commits
25+
5. Copy `post-commit` to a project's `.git/hooks` directory to have it save
26+
dummy commits
2227

2328
## Check that it works
2429

2530
1. Create a local commit for a project with `post-commit` installed
26-
2. Check that your dummy commit repository (e.g. `git-history`) received the dummy commit
31+
2. Check that your dummy commit repository (e.g. `git-history`) received the
32+
dummy commit

0 commit comments

Comments
 (0)