Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.73 KB

README.md

File metadata and controls

53 lines (37 loc) · 2.73 KB
Raw

git_log_md.py

Uses git log to create a Markdown document listing the message, hash, and timestamp for each commit.

This tool was created to explore documenting a series of commits along with other details about the changes. This provides a way to add notes and links related to a commit, or a group of commits, after the fact. An example use of the output from this tool is in the Coursework Links and Commits section of devnotes.md in the wmelvin/pub-py-pkg repository.

For a large project, or one with multiple comtributors, it makes sense to use an issue tracker and reference issue tags in commit messages. When making a series of small commits, in a learning project or coursework, it seems like using issues would add unnecessary overhead.

A task list completed item checkmark can be added in front of commit the message using the --do-mark switch.

GitHub Docs: About task lists

The commit hash and date can be styled as superscript using the --do-sup switch.

GitHub Docs: styling text

Command-Line Usage

usage: git_log_md.py [-h] [-u REPO_URL] [-o FILE_NAME] [-t] [--git-out]
                     [--do-mark] [--do-sup]
                     [dir_name]

Create a markdown listing commits to a Git repository at a given path.

positional arguments:
  dir_name              Name of directory containing the Git repository.

options:
  -h, --help            show this help message and exit
  -u REPO_URL, --repo-url REPO_URL
                        GitHub repository URL.
  -o FILE_NAME, --output FILE_NAME
                        Name of output file.
  -t, --timestamp       Add a timestamp (date_time) tag to the output file
                        name.
  --git-out             Print the output (STDOUT and STDERR) from running the
                        'git log' command.
  --do-mark             Add a task-list-completed-item checkmark in front of
                        the commit message.
  --do-sup              Add superscript tags around the commit hash and date.

Reference

Git Documentation: