Generate Markdown Commit Link Script

# Generate Markdown Commit Link Script.md

Generate Markdown Commit Link Script

This script generates a Markdown-formatted link to the most recent Git commit in a repository, including the commit’s date/time, short SHA, and message. It’s designed for use as a Git alias but can also be run standalone.

Features

• Converts SSH repository URLs to HTTPS automatically.
• Outputs a link in the format:

  [YYYY-MM-DD HH:MM - shortSHA - commit message](repo_url/commit/shortSHA) #git/commit
  

  For example:

  [2024-12-19 11:57 - a4a92bf5 - Merge pull request #2](https://github.com/HBS-HBX/graph-ai-nego/commit/a4a92bf5) #git/commit
  

• Supports a --short mode to output only the commit URL.

Installation

1. Save the generate_markdown_commit_link.zsh script to ~/.config/git/scripts/.
2. Add the alias to your ~/.gitconfig:

   [alias]
       md-commit = "!zsh ~/.config/git/scripts/generate_markdown_commit_link.zsh"

After that, you can run git md-commit to generate the Markdown link.

.gitconfig

[alias]
    md-commit = "!zsh ~/.config/git/scripts/generate_markdown_commit_link.zsh"

generate_markdown_commit_link.zsh

#!/usr/bin/env zsh

# Purpose: Generate a Markdown link for the most recent Git commit, including date/time.
# Example: [2024-12-19 11:57 - abc12345 - Fix login bug](https://github.com/username/repo/commit/abc12345) #git/commit
#
# Note: This version uses git's built-in date formatting rather than `date -d`,
# to ensure compatibility with systems like macOS where `date -d` isn't available.

# Parse arguments
SHORT_MODE=false

while [[ "$1" != "" ]]; do
    case $1 in
        --)
            ;;
        --help)
            cat <<EOF
generate_markdown_commit_link.zsh - Generate a Markdown link for the most recent Git commit.
USAGE:
  zsh generate_markdown_commit_link.zsh [--help] [--short]
OPTIONS:
  --help      Display this help information.
  --short     Output only the short SHA link without the commit message or date/time.
EOF
            exit 0
            ;;
        --short)
            SHORT_MODE=true
            ;;
        *)
            echo "Error: Unknown option '$1'. Use --help for usage information." >&2
            exit 1
            ;;
    esac
    shift
done

# Get repository URL and convert SSH to HTTPS
REPO_URL=$(git config --get remote.origin.url)
if [[ "$REPO_URL" =~ ^git@ ]]; then
    REPO_URL=$(echo "$REPO_URL" | sed -E 's|git@([^:]+):|https://\1/|')
fi
REPO_URL=$(echo "$REPO_URL" | sed 's/\.git$//')

# Get commit details
COMMIT_SHA=$(git log -1 --pretty=format:"%h" --abbrev=8)
COMMIT_MSG=$(git log -1 --pretty=format:"%s" | cut -c 1-72)
COMMIT_DATE=$(git log -1 --pretty=format:"%cd" --date=format:'%Y-%m-%d %H:%M')

# Output result
if $SHORT_MODE; then
    echo "$REPO_URL/commit/$COMMIT_SHA"
else
    echo "[$COMMIT_DATE - $COMMIT_SHA - $COMMIT_MSG]($REPO_URL/commit/$COMMIT_SHA) #git/commit"
fi