ClickHouse

mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-12-18 20:32:43 +00:00

History

Alexey Milovidov 3945df7680 Add changelog for 24.12		2024-12-15 23:37:04 -08:00
..
.gitignore	Add caching for GitHub PR objects	2022-05-25 00:05:53 +02:00
changelog.py	Move changelog script to tests/ci	2024-06-12 14:43:22 +02:00
README.md	Add changelog for 24.12	2024-12-15 23:37:04 -08:00
requirements.txt	Add changelog for 24.12	2024-12-15 23:37:04 -08:00

README.md

How To Generate Changelog

Generate github token:

https://github.com/settings/tokens - keep all checkboxes unchecked, no scopes need to be enabled.

Dependencies:

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

Usage example:

Note: The working directory is ClickHouse/utils/changelog

GITHUB_TOKEN="<your token>"

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

How to use it on Mac

Python has notoriously poor developer experience - it is a pile of garbage.

Here is how to use it:

brew install python
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
./changelog.py --gh-user-or-token ghp_... --from a79faf5da8027c201a94cdc5c9a6a1d7852d69b5 95ccb0e1a86fd26a50b11a9479586e973dba66ce