git-extras Documentation

Technical Documentation: tj/git-extras

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`Readme.md`) Copy Section

Git Extras

Little git extras.

Screencasts Copy Chapter

Just getting started? Check out these screencasts:

• introduction (archive.org link) -- covers git-ignore, git-setup, git-changelog, git-release, git-effort and more

Installation Copy Chapter

See the Installation page.

Commands Copy Chapter

Go to the Commands page for basic usage and examples.

GIT utilities -- repo summary, repl, changelog population, author commit percentages and more

Contributing Copy Chapter

Interested in contributing? Awesome!

Please read Contributing before you make a PR, thanks!

The change of the default branch Copy Chapter

As of Git Extras 6.4 the assumed default branch name changed from master to main.
This affects the Git Extras commands git archive-file, git delete-merged-branches, git delta, git pull-request, git show-merged-branches, git show-unmerged-branches, and git squash.

To change the default branch name to master: change either the configuration git-extras.default-branch or init.defaultBranch to master; the former takes precedence.

For example, git config git-extras.default-branch master.

Overview (`man/Readme.md`) Copy Section

How to generate documentation:

DESCRIPTION Copy Chapter

To generate documentation:

1. Start by filling out the 'man-template.md'

2. Then install a program ronn. Get ronn from github.

3. Run make:

(Assumed you are under ./man when running the command below)

$ make -C .. man/git-<command>.{1,html}

4. Remember, we use the following naming convention for files:

git-<command>.html
git-<command>.1
git-<command>.md

AUTHOR Copy Chapter

Written by Leila Muhtasib <[email protected]>
Shell Script by Nick Lombard <[email protected]>

REPORTING BUGS Copy Chapter

<https://github.com/tj/git-extras/issues>

SEE ALSO Copy Chapter

<https://github.com/tj/git-extras>

Overview (`tests/README.md`) Copy Section

Testing

Tests are written in Bats so coverage can be calculated for shell commands.

Bats Testing Copy Chapter

We require a somewhat recent version of Bats. Version v1.8.1 is tested in CI. Once it is installed, the tests can be executed like so:

bats ./tests

We highly recommend adding Bats tests for new features and fixes.

Code Coverage Copy Section

Coverage can be calculated with bashcov like so:

bashcov -- bats ./tests

By default, the report will be generated in ./coverage/index.html.

--- METRICS ---

• Files Extracted: 3
• Estimated Token Budget: ~724 tokens
• Canonical Reference: https://codewiki.google/github.com/tj/git-extras