diff --git a/.github/workflows/example_notifier.yml b/.github/workflows/example_notifier.yml new file mode 100644 index 000000000..661f63431 --- /dev/null +++ b/.github/workflows/example_notifier.yml @@ -0,0 +1,14 @@ +name: Warning maintainers +on: + pull_request: + paths: examples/** +jobs: + job: + runs-on: ubuntu-latest + name: about example change + steps: + - name: running the check + uses: Poolitzer/notifier-action@master + with: + notify-message: Hey there. Relax, I am just a little warning for the maintainers to release directly after merging your PR, otherwise we have broken examples and people might get confused :) + repo-token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/examples/README.md b/examples/README.md index 3adda0430..e6e2241d2 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,6 @@ # Examples -In this folder there are small examples to show what a bot written with `python-telegram-bot` looks like. Some bots focus on one specific aspect of the Telegram Bot API while others focus on one of the mechanics of this library. Except for the [`echobot.py`](#pure-api) example, they all use the high-level framework this library provides with the [`telegram.ext`](https://python-telegram-bot.readthedocs.io/en/latest/telegram.ext.html) submodule. +In this folder are small examples to show what a bot written with `python-telegram-bot` looks like. Some bots focus on one specific aspect of the Telegram Bot API while others focus on one of the mechanics of this library. Except for the [`echobot.py`](#pure-api) example, they all use the high-level framework this library provides with the [`telegram.ext`](https://python-telegram-bot.readthedocs.io/en/latest/telegram.ext.html) submodule. All examples are licensed under the [CC0 License](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/LICENSE.txt) and are therefore fully dedicated to the public domain. You can use them as the base for your own bots without worrying about copyrights. @@ -35,4 +35,4 @@ A basic example of a bot that can accept payments. Don't forget to enable and co A basic example of a bot store conversation state and user_data over multiple restarts. ## Pure API -The [`echobot.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/echobot.py) example uses only the pure, "bare-metal" API wrapper. +The [`echobot.py`](https://github.com/python-telegram-bot/python-telegram-bot/blob/master/examples/echobot.py) example uses only the pure, "bare-metal" API wrapper.