Skip to content

[0pt] Automate changelog review tracking #2544

@patiencedaur

Description

@patiencedaur

Epic: Release notes

Helps with tarantool/tarantool#6430.

Problem

Individual changelog lines are kept in a tarantool/tarantool directory, which is constantly updated.
Release notes for every release are compiled from these individual changelogs by a script.

The changelog directory is updated each time a new feature is ready.

We need to proofread each changelog file and keep track of their status.

  • There are many files in the dir and three branches to keep track of: 1.10, 2.8., and master. That is, three "instances" of the folder.
  • The changelogs are updated without our involvement.

Therefore, it would be nice to automate the process.

Proposal

Create a script that runs every two weeks and does the following:

  • Collects new file names/links from the changelogs/unreleased folder for 1.10, 2.8, and master branches.
  • Inserts them in a table:
    • File name
    • Release versions the changelog will be included into
    • Review status ("no" by default, will be updated manually by doc team)
    • Corresponding dev epic (empty by default, will be updated manually by doc team)
    • Corresponding doc issue (empty by default, will be updated manually by doc team)
  • (Optional) Notifies about running.

Reviewer: @ patiencedaur

Metadata

Metadata

Assignees

No one assigned

    Labels

    internalTechnical debt in the docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions