Skip to content

docs: CHANGELOG.md with the version history (#228) - #231

Merged
compot-dev merged 1 commit into
v2from
docs/changelog
Oct 17, 2026
Merged

compot-dev merged 1 commit into
v2from
docs/changelog

Conversation

@compot-dev

Copy link
Copy Markdown
Collaborator

Closes #228.

  • CHANGELOG.md in the vtesse format: a header (where the version lives for v2 and basic, builds are published only as latest and in Telegram, no releases per version, Releases: keep only latest and test pre-releases, no per-version releases #194) and one section per v2 version, newest first, 2.17 down to 2.00. A version bump commit only says "chore: version X", so each section was filled from the pull request that brought the version (the first-parent merges of v2), with PR and issue numbers; CI-only PRs merged within a version are listed under it.
  • 2.14 is not there: it went to fix: streams above 1080p in the single view (#166) #220, which is still open. "Before 2.00" points to the git history for the 1.x line of v2.
  • Legacy basic: 1.07.1 (PR fix(basic): RTSP handshake, EOF, thread lifecycle, SDP parsing, CI (#36–#40) #41) and 1.07 (from the "Version history" in the basic README).
  • README.md, README.ru.md, README.zh-CN.md: one line in "Download" pointing to CHANGELOG.md.
  • docs/testing.md, "Versions and releases": the version bump commit of an app PR adds its CHANGELOG.md section.

The version scheme itself (MAJOR.MINOR.PATCH) changes with #230; this PR keeps the headings as the versions were released.

Docs only: no version bump.

One section per v2 version, newest first, 2.17 down to 2.00, each
filled from the pull request that brought it, then "Before 2.00" and
the legacy basic line (1.07.1, 1.07). The three READMEs point to it;
docs/testing.md says that the version bump commit adds its section.

Refs #228
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can see how risky a PR is at a glance with blast radius labels

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document version history and changelog maintenance

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Add a changelog for v2 versions 2.00–2.17 and legacy basic releases, with PR references.
• Link the changelog from the English, Russian, and Chinese download instructions.
• Require app version-bump commits to add a changelog section in the same pull request.
Diagram

graph TD
  T["Testing guide"] --> B["Version bump"] --> C["CHANGELOG.md"] --> D["Download READMEs"] --> R(["Readers"])
  P["Merged PRs"] --> C
Loading
High-Level Assessment

A curated changelog fits a project that publishes builds under latest rather than issuing releases per version. Generating entries from version-bump commits was considered, but those commits do not describe the underlying changes.

Files changed (5) +126 / -0

Documentation (5) +126 / -0
CHANGELOG.mdAdd curated v2 and legacy basic version history +119/-0

Add curated v2 and legacy basic version history

• Introduces newest-first entries for released v2 versions 2.00–2.17, with PR and issue references; 2.14 is absent. It also points earlier v2 history to git and records basic versions 1.07.1 and 1.07, while explaining where builds and version numbers live.

CHANGELOG.md

README.mdLink English download instructions to the changelog +2/-0

Link English download instructions to the changelog

• Adds a link to the version history beside the download and release information.

README.md

README.ru.mdLink Russian download instructions to the changelog +2/-0

Link Russian download instructions to the changelog

• Adds a Russian-language pointer to the version history in the download section.

README.ru.md

README.zh-CN.mdLink Chinese download instructions to the changelog +2/-0

Link Chinese download instructions to the changelog

• Adds a Chinese-language pointer to the version history in the download section.

README.zh-CN.md

testing.mdDocument changelog updates during app version bumps +1/-0

Document changelog updates during app version bumps

• Specifies that the version-bump commit in an app-changing PR must add a newest-first changelog section for that version.

docs/testing.md

@compot-dev
compot-dev merged commit 7e4e03f into v2 Oct 17, 2026
4 checks passed
@compot-dev
compot-dev deleted the docs/changelog branch October 17, 2026 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CHANGELOG.md with the version history

1 participant