From 6a0fcb5d0453159444e03776eec8559fc239adcf Mon Sep 17 00:00:00 2001 From: Rongrong <15956627+Rongronggg9@users.noreply.github.com> Date: Sat, 2 Apr 2022 18:32:50 +0800 Subject: [PATCH] chore: release v2.2.1 Signed-off-by: Rongrong <15956627+Rongronggg9@users.noreply.github.com> --- README.md | 12 ++++++------ README.zh.md | 12 ++++++------ docs/CHANGELOG.md | 28 ++++++++++++++++++++++++++++ docs/CHANGELOG.zh.md | 28 ++++++++++++++++++++++++++++ docs/deployment-guide.md | 20 +++++++++++++------- src/version.py | 2 +- 6 files changed, 82 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 711d82837a..8559f554d5 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,21 @@ [简体中文 README](README.zh.md) -[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Rongronggg9/RSS-to-Telegram-Bot?logo=git)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/commits) +[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Rongronggg9/RSS-to-Telegram-Bot?logo=git&label=commit)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/commits) [![Translating status](https://img.shields.io/weblate/progress/rss-to-telegram-bot?logo=weblate&color=informational)](https://hosted.weblate.org/engage/rss-to-telegram-bot/) [![Code quality](https://img.shields.io/codefactor/grade/github/Rongronggg9/RSS-to-Telegram-Bot?logo=codefactor)](https://www.codefactor.io/repository/github/rongronggg9/rss-to-telegram-bot) [![GitHub stars](https://img.shields.io/github/stars/Rongronggg9/Rss-to-Telegram-Bot?style=social)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/stargazers) [![GitHub forks](https://img.shields.io/github/forks/Rongronggg9/RSS-to-Telegram-Bot?style=social)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/fork) -[![PyPI](https://img.shields.io/pypi/v/rsstt?logo=pypi)](https://pypi.org/project/rsstt/) -[![PyPI publish status](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20to%20PyPI?label=publish&logo=pypi)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-to-pypi.yml) -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rsstt) -![PyPI - License](https://img.shields.io/pypi/l/rsstt?color=informational) +[![PyPI](https://img.shields.io/pypi/v/rsstt?logo=pypi&logoColor=white)](https://pypi.org/project/rsstt/) +[![PyPI publish status](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20to%20PyPI?label=publish&logo=pypi&logoColor=white)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-to-pypi.yml) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/rsstt?logo=pypi&logoColor=white)](https://pypi.org/project/rsstt/) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rsstt?logo=python&label=&labelColor=white)](https://www.python.org) [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/rongronggg9/rss-to-telegram/latest?logo=docker)](https://hub.docker.com/r/rongronggg9/rss-to-telegram) [![Build status (master)](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20Docker%20image/master?label=build&logo=docker)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-docker-image.yml?query=branch%3Amaster) [![Build status (dev)](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20Docker%20image/dev?label=build%20%28dev%29&logo=docker)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-docker-image.yml?query=branch%3Adev) -[![Docker pulls](https://img.shields.io/docker/pulls/rongronggg9/rss-to-telegram?label=pulls&logo=docker)](https://hub.docker.com/r/rongronggg9/rss-to-telegram) +[![Docker pulls](https://img.shields.io/docker/pulls/rongronggg9/rss-to-telegram?label=pulls&logo=docker&color=informational)](https://hub.docker.com/r/rongronggg9/rss-to-telegram) RSStT_icon diff --git a/README.zh.md b/README.zh.md index 7c2c755498..e6f89d0268 100644 --- a/README.zh.md +++ b/README.zh.md @@ -4,21 +4,21 @@ [English README](README.md) -[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Rongronggg9/RSS-to-Telegram-Bot?logo=git)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/commits) +[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Rongronggg9/RSS-to-Telegram-Bot?logo=git&label=commit)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/commits) [![Translating status](https://img.shields.io/weblate/progress/rss-to-telegram-bot?logo=weblate&color=informational)](https://hosted.weblate.org/engage/rss-to-telegram-bot/) [![Code quality](https://img.shields.io/codefactor/grade/github/Rongronggg9/RSS-to-Telegram-Bot?logo=codefactor)](https://www.codefactor.io/repository/github/rongronggg9/rss-to-telegram-bot) [![GitHub stars](https://img.shields.io/github/stars/Rongronggg9/Rss-to-Telegram-Bot?style=social)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/stargazers) [![GitHub forks](https://img.shields.io/github/forks/Rongronggg9/RSS-to-Telegram-Bot?style=social)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/fork) -[![PyPI](https://img.shields.io/pypi/v/rsstt?logo=pypi)](https://pypi.org/project/rsstt/) -[![PyPI publish status](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20to%20PyPI?label=publish&logo=pypi)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-to-pypi.yml) -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rsstt) -![PyPI - License](https://img.shields.io/pypi/l/rsstt?color=informational) +[![PyPI](https://img.shields.io/pypi/v/rsstt?logo=pypi&logoColor=white)](https://pypi.org/project/rsstt/) +[![PyPI publish status](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20to%20PyPI?label=publish&logo=pypi&logoColor=white)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-to-pypi.yml) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/rsstt?logo=pypi&logoColor=white)](https://pypi.org/project/rsstt/) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rsstt?logo=python&label=&labelColor=white)](https://www.python.org) [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/rongronggg9/rss-to-telegram/latest?logo=docker)](https://hub.docker.com/r/rongronggg9/rss-to-telegram) [![Build status (master)](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20Docker%20image/master?label=build&logo=docker)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-docker-image.yml?query=branch%3Amaster) [![Build status (dev)](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20Docker%20image/dev?label=build%20%28dev%29&logo=docker)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-docker-image.yml?query=branch%3Adev) -[![Docker pulls](https://img.shields.io/docker/pulls/rongronggg9/rss-to-telegram?label=pulls&logo=docker)](https://hub.docker.com/r/rongronggg9/rss-to-telegram) +[![Docker pulls](https://img.shields.io/docker/pulls/rongronggg9/rss-to-telegram?label=pulls&logo=docker&color=informational)](https://hub.docker.com/r/rongronggg9/rss-to-telegram) RSStT_icon diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index bca72cc5ed..b03b2887b8 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,5 +1,33 @@ # Changelog +## Published to PyPI, HTML table converter, and more (v2.2.1) + +### Additions + +#### Highlights + +- **Published to PyPI**: RSStT is now available on [PyPI](https://pypi.org/project/rsstt/). You may install it with `pip install rsstt`. For more details, refer to the [Deployment Guide](deployment-guide.md). +- **HTML table converter**: An HTML table converter has been implemented to convert HTML tables to images. It requires the environment variable `TABLE_TO_IMAGE` to be set to `1`, and CJK fonts to be installed. Please do note that the converter is not perfect, cannot handle rich-text formatting, may not work for all HTML tables, and can potentially lead to a higher performance cost and longer processing time. + +### Other additions + +- **New l10n**: The Indonesian (`id`, Bahasa Indonesia) translation has been added. +- **Add `.env.sample`**: A sample `.env` file has been added. + +### Enhancements + +- **Natural sorting**: Send posts from the oldest to the newest. +- **Timed GC**: Perform a GC (garbage collection) every 10 minutes to clean up the memory. +- **Update l10n**: The Turkish (`tr`, Türkçe) translation has been updated. +- **Security**: Execute `git` outside of the shell. +- **Minor enhancements** + +### Bug fixes + +- **Misfired monitor job**: Increased the `misfire_grace_time` to 10s to avoid monitor jobs being misfired because of high load. +- **Deps bump**: Fixed an upstream bug preventing users from resetting all subscriptions to the user's default settings on a PostgreSQL-based instance. +- **Minor bug fixes** + ## Channel remote management, more formatting options, and more (v2.2.0) ### Additions diff --git a/docs/CHANGELOG.zh.md b/docs/CHANGELOG.zh.md index 28be23c89e..1934df8596 100644 --- a/docs/CHANGELOG.zh.md +++ b/docs/CHANGELOG.zh.md @@ -1,5 +1,33 @@ # 更新日志 +## 发布至 PyPI、HTML 表格转换器和更多 (v2.2.1) + +### 新特性 + +#### 亮点 + +- **发布至 PyPI**: RSStT 现在可从 [PyPI](https://pypi.org/project/rsstt/) 中获取。可通过 `pip install rsstt` 来安装。详细信息请参阅[部署指南](deployment-guide.md). +- **HTML 表格转换器**: 实现了一个 HTML 表格转换器，可以将 HTML 表格转换为图片。需要将环境变量 `TABLE_TO_IMAGE` 设置为 `1`，并且需要安装 CJK 字体。请注意，转换器不是完美的，不能处理富文本格式，可能无法处理所有的 HTML 表格，并可能会导致更高的性能成本和更长的处理时间。 + +### 其他新特性 + +- **新的本地化**: 增加了印度尼西亚语 (`id`, Bahasa Indonesia) 的翻译。 +- **增加 `.env.sample`**: 增加了范例 `.env` 文件。 + +### 增强 + +- **自然排序**: 从旧到新推送文章。 +- **定时 GC**: 每 10 分钟执行一次 GC (垃圾回收) 以清理内存。 +- **本地化更新**: 更新了土耳其语 (`tr`, Türkçe) 的翻译。 +- **安全**: 在 shell 之外执行 `git` 。 +- **次要的增强** + +### Bug 修复 + +- **监视任务启动失败**: 增加了 `misfire_grace_time` 至 10s 以避免监视任务由于高负载未能启动。 +- **依赖更新**: 修复了一个阻止用户在使用 PostgreSQL 的实例上重置所有订阅到用户的默认设置的上游 bug。 +- **次要的 bug 修复** + ## 频道远程管理、更多格式化选项和更多 (v2.2.0) ### 新特性 diff --git a/docs/deployment-guide.md b/docs/deployment-guide.md index 8498cef488..952672e109 100644 --- a/docs/deployment-guide.md +++ b/docs/deployment-guide.md @@ -10,9 +10,10 @@ ## Option 1: Docker Compose -[![Build status (master)](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20Docker%20image/master?label=build%20%28master%29&logo=docker)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-docker-image.yml?query=branch%3Amaster) +[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/rongronggg9/rss-to-telegram/latest?logo=docker)](https://hub.docker.com/r/rongronggg9/rss-to-telegram) +[![Build status (master)](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20Docker%20image/master?label=build&logo=docker)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-docker-image.yml?query=branch%3Amaster) [![Build status (dev)](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20Docker%20image/dev?label=build%20%28dev%29&logo=docker)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-docker-image.yml?query=branch%3Adev) -[![Docker pulls](https://img.shields.io/docker/pulls/rongronggg9/rss-to-telegram?label=pulls&logo=docker)](https://hub.docker.com/r/rongronggg9/rss-to-telegram) +[![Docker pulls](https://img.shields.io/docker/pulls/rongronggg9/rss-to-telegram?label=pulls&logo=docker&color=informational)](https://hub.docker.com/r/rongronggg9/rss-to-telegram) For the docker images go to: https://hub.docker.com/r/rongronggg9/rss-to-telegram @@ -118,11 +119,11 @@ You know what to do. However, I cannot guarantee that the fonts can be recognize ### Option 4.1: Install from PyPI -[![PyPI](https://img.shields.io/pypi/v/rsstt)](https://pypi.org/project/rsstt/) -[![PyPI publish status](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20to%20PyPI?label=publish&logo=pypi)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-to-pypi.yml) -![PyPI - Implementation](https://img.shields.io/pypi/implementation/rsstt) -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rsstt) -![PyPI - License](https://img.shields.io/pypi/l/rsstt?color=informational) +[![PyPI](https://img.shields.io/pypi/v/rsstt?logo=pypi&logoColor=white)](https://pypi.org/project/rsstt/) +[![PyPI publish status](https://img.shields.io/github/workflow/status/Rongronggg9/RSS-to-Telegram-Bot/Publish%20to%20PyPI?label=publish&logo=pypi&logoColor=white)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/actions/workflows/publish-to-pypi.yml) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/rsstt?logo=pypi&logoColor=white)](https://pypi.org/project/rsstt/) +[![PyPI - Implementation](https://img.shields.io/pypi/implementation/rsstt?logo=python)](https://www.python.org) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rsstt?logo=python)](https://www.python.org) > Create a virtual environment (`venv`) and activate it first if needed. > Default config folder is `~/.rsstt`. @@ -138,6 +139,11 @@ python3 -m rsstt ### Option 4.2: Dirty run from source +[![GitHub repo size](https://img.shields.io/github/repo-size/Rongronggg9/RSS-to-Telegram-Bot?logo=github)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/archive/refs/heads/dev.zip) +[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/Rongronggg9/RSS-to-Telegram-Bot?include_prereleases&sort=semver&logo=github)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/releases) +[![GitHub last commit (dev)](https://img.shields.io/github/last-commit/Rongronggg9/RSS-to-Telegram-Bot/dev?logo=github)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/commits/dev) +[![GitHub commits since latest release (by SemVer including pre-releases)](https://img.shields.io/github/commits-since/Rongronggg9/RSS-to-Telegram-Bot/latest?include_prereleases&sort=semver&logo=github)](https://github.com/Rongronggg9/RSS-to-Telegram-Bot/commits/dev) + > Default config folder is `./config`, default `.env` path is `./.env` (placing it inside the config folder is also supported). ```sh diff --git a/src/version.py b/src/version.py index df602ef261..b19ee4b77e 100644 --- a/src/version.py +++ b/src/version.py @@ -1 +1 @@ -__version__ = "2.2.1b2" +__version__ = "2.2.1"