pylint-dev/pylint

Better release notes generation and automated release process

Open

#7,362 opened on 2022年8月26日

GitHub で見る
 (6 comments) (0 reactions) (0 assignees)Python (4,978 stars) (1,059 forks)batch import
Enhancement ✨Good first issueHacktoberfestHelp wanted 🙏MaintenanceMinor 💅

説明

Current problem

  • We have to cherry-pick manually #7776
  • contributor-txt pollutes the contributor file with a header because it does not detect the existing header fixed in #7656
  • The contributor needs to be sorted manually because contributor-txt does not handle it
  • The release notes are generated as rst but github want markdown
  • The new release note file is not included in any toctree
  • Only the first link is generated when there is two or more issues referenced in a fragment
  • if false-positive is used instead of false_positive the changelog check is green but the result is not automatically added to the release note see #7369 #7903
  • The release note generated from patch create a duplicated title #7393 fixed in #7589
  • The release date is not automatically added in the documentation (0fba80c8c)
  • Consider automating the deduplication of changelog fragments during patch releases (ref #9301)

Desired solution

Markdown creation so it can be used in both context, other issue automatically fixed

Additional context

Noticed during the release of 2.15.0.

コントリビューターガイド

技術スタック
python
領域
releasedocumentationtooling
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
4
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
over 1 week
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
mostly clear
前提条件
Pythonrelease engineering basicsfamiliarity with towncrier
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
25
調査方針
The issue describes several remaining tasks: converting release notes from RST to Markdown, ensuring new note files are included in a toctree, handling multiple issue references in a fragment, and automating deduplication. Investigate the current release process in the pylint repository, particularly the towncrier configuration and the release script (likely in `scripts/` or `Makefile`). Look at recent PRs like #9301 for context on deduplication. The goal is to propose a concrete plan to automate these steps, possibly by modifying the CI workflow or the towncrier config.