pylint-dev/pylint

Better release notes generation and automated release process

Open

#7,362 opened on Aug 26, 2022

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

Description

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.

Contributor guide

Tech stack
python
Domain
releasedocumentationtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Pythonrelease engineering basicsfamiliarity with towncrier
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
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.