Add script to generate a markdown changelog

This commit is contained in:
Martin Fournier 2022-01-18 15:40:36 -05:00
parent 05cbc25a8f
commit e5d951ed05
2 changed files with 33 additions and 0 deletions

@ -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
```

23
tools/changelog.sh Normal file

@ -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