https://github.com/python-telegram-bot/ptb-changelog-helper

A little something to help PTB devs with their releases.
https://github.com/python-telegram-bot/ptb-changelog-helper

Last synced: about 2 months ago
JSON representation

A little something to help PTB devs with their releases.

• Host: GitHub
• URL: https://github.com/python-telegram-bot/ptb-changelog-helper
• Owner: python-telegram-bot
• Created: 2020-06-25T06:15:07.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-01T14:49:56.000Z (10 months ago)
• Last Synced: 2025-01-01T15:32:19.147Z (10 months ago)
• Language: Python
• Size: 98.6 KB
• Stars: 4
• Watchers: 8
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
> [!Warning]

> This repo is archived, as `python-telegram-bot` uses [`chango`](https://chango.readthedocs.io/stable/) since [v22](https://docs.python-telegram-bot.org/en/v22.0/changelog.html#documentation).

# ptb-release-helper

*A little something to help PTB devs with their releases.* 

Logging changes from the commit history is a tiresome process and even more so, if you need the log in different markup languages.

The devs of [`python-telegram-bot`](https://python-telegram-bot.org) have to fear no more!

## What it does/How it's used:

1. Install the python requirements by `pip install -r requirements.txt`.

2. Save a copy of `example_main.py` as `main.py` and fill in your configurations:

   * `new_version`: The version that you are about to release

   * `github_token`: A GitHub GraphQL token with read access to the PTB organisation

   * `bot_token`: A Telegram Bot token

   * `telegram_chat_id`: A chat ID the bot can send messages to, preferably yours

   * `ptb_dir`: The path to your local clone of the PTB repository

3. Run `python main.py`. This fetches the current changelog and guides you through the next steps. In the end, you will have a message on Telegram ready to be copied to the PTB channel and the PTB repository will be ready for the release commit.

That's it. Happy releasing! 🙂