ClickHouse/utils/changelog/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

26 lines
877 B
Markdown
Raw Normal View History

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:
```
sudo apt-get update
sudo apt-get install git python3 python3-fuzzywuzzy python3-github
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
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`
2022-09-14 14:53:15 +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
```