2021-11-02 11:38:17 +00:00
|
|
|
## How To Generate Changelog
|
2021-06-04 22:12:38 +00:00
|
|
|
|
2021-08-05 11:19:13 +00:00
|
|
|
Generate github token:
|
|
|
|
|
* https://github.com/settings/tokens - keep all checkboxes unchecked, no scopes need to be enabled.
|
|
|
|
|
|
|
|
|
|
Dependencies:
|
|
|
|
|
```
|
2022-05-09 19:14:35 +00:00
|
|
|
sudo apt-get update
|
2024-06-04 11:37:36 +00:00
|
|
|
sudo apt-get install git python3 python3-thefuzz python3-github
|
2022-05-09 19:14:35 +00:00
|
|
|
python3 changelog.py -h
|
2021-11-02 11:38:02 +00:00
|
|
|
```
|
2021-08-05 11:19:13 +00:00
|
|
|
|
2021-06-04 22:12:38 +00:00
|
|
|
Usage example:
|
|
|
|
|
|
2023-02-20 14:49:14 +00:00
|
|
|
Note: The working directory is ClickHouse/utils/changelog
|
|
|
|
|
|
|
|
|
|
```bash
|
2024-06-04 11:37:36 +00:00
|
|
|
GITHUB_TOKEN="<your token>"
|
2022-09-14 14:53:15 +00:00
|
|
|
|
2022-05-09 19:14:35 +00:00
|
|
|
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
|
2021-06-04 22:12:38 +00:00
|
|
|
```
|
2024-12-16 07:37:04 +00:00
|
|
|
|
|
|
|
|
## How to use it on Mac
|
|
|
|
|
|
|
|
|
|
Python has notoriously poor developer experience - it is a pile of garbage.
|
|
|
|
|
|
|
|
|
|
Here is how to use it:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
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
|
|
|
|
|
```
|
