Issues

Collect all issue comments (e.g. TODO, FIXME, ...) in one file.

Usage

Copy the script issues.sh to your git repository, for example via:

wget https://raw.githubusercontent.com/DavidHeresy/git-issues/main/issues.sh

Generate the ISSUES.md file with:

bash issues.sh

You can also set an alias like:

alias issues="bash issues.sh"

Ignore Some Files

You can specify which files to ignore in the .issuesignore file. Is supports comments starting with # and POSIX extended regex patterns.

Other

• TODO: Use as Git Hook
• TODO: Setup as Git Alias
• TODO: Explain use of git grep at HEAD.

Development

Run source workspace to enter the development environment.

Roadmap

• TODO: Generate ISSUES.md with a remote git hook.
• TODO: Make issues.sh work for projects, that aren't a git repository.
• IDEA: Aggregate issues in JSON format and only project to Markdown. (Use jq for that.)
• IDEA: Project issues in todo.txt format.