ClickHouse/utils/changelog/README.md
2023-02-20 09:49:14 -05:00

877 B

How To Generate Changelog

Generate github token:

Dependencies:

sudo apt-get update
sudo apt-get install git python3 python3-fuzzywuzzy python3-github
python3 changelog.py -h

Usage example:

Note: The working directory is ClickHouse/utils/changelog

export GITHUB_TOKEN="<your token>"

git fetch --tags # changelog.py depends on having the tags available, this will fetch them.  
                 # If you are working from a branch in your personal fork, then you may need `git fetch --all`

python3 changelog.py --output=changelog-v22.4.1.2305-prestable.md --gh-user-or-token="$GITHUB_TOKEN" v21.6.2.7-prestable
python3 changelog.py --output=changelog-v22.4.1.2305-prestable.md --gh-user-or-token="$USER" --gh-password="$PASSWORD" v21.6.2.7-prestable