diff --git a/tools/README.md b/tools/README.md index 0f2e5f759..e9cb7e57b 100644 --- a/tools/README.md +++ b/tools/README.md @@ -20,3 +20,13 @@ Used to synchronize the achievements info in steamworks to the game's data.json # Get your key here: https://steamcommunity.com/dev/apikey node fetch-steam-achievements-data.js DEVKEYDEVKEYDEVKEYDEVKEY ``` + +## Changelog script + +Used to generate a basic git commit log (in markdown) between commit A & commit B + +**Usage** +```sh +# Will default to HEAD if second is not specified. +./tools/changelog.sh 9a0062b 05cbc25 +``` diff --git a/tools/changelog.sh b/tools/changelog.sh new file mode 100644 index 000000000..11d59b7fa --- /dev/null +++ b/tools/changelog.sh @@ -0,0 +1,23 @@ +#!/bin/sh + +version=${2:-HEAD} +cat >> temp_changelog.md << EOF +# v1.X.X ($version) + +Description Here. + +Compare Commits [on github](https://github.com/danielyxie/bitburner/compare/$1...$version). + +--- + +### Commits +EOF + +git log $1...${version} \ + --pretty=format:'* [`%h`]([https://github.com/danielyxie/bitburner/commit/%H): %s (by %aN on %ad) %n' \ + --date=short \ + --no-merges >> temp_changelog.md + # --reverse >> temp_changelog.md + +rm -f changelog_$1_${version}.md +mv temp_changelog.md changelog_$1_${version}.md