Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-27 00:17:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2692 from MartinFournier/tool/changelog

Browse Source 
Add script to generate a markdown changelog
This commit is contained in:
hydroflame 2022-01-18 16:53:55 -05:00 committed by GitHub
commit 56213a109c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
tools/README.md
View File

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