Skip to content

docs-issue-generation: it can miss processing backport PRs #72910

@jlinder

Description

@jlinder

The docs issue creation script should create a new cockroachdb/docs issue for every cockroach commit containing a Release note. But in its current setup, it can miss processing some merge commits for backport PRs when multiple PRs are merged to the same branch closely together. The reasons for this are:

  1. TeamCity is taking up to 10 or 15 minutes to see new commits on a branch
  2. When TeamCity sees new commits on a branch, it only runs a build for the latest commit
  3. The docs issue creation script only processes PRs merged in the merge commit it is supplied with (it doesn't go further backward in the commit history)

Solution:

  1. Change the build configuration to run every X hours (nightly/hourly/every three hours; a.k.a the TIME_WINDOW)
  2. Update the script to track the commits it has successfully processed, look at all the commits merged to the branch between the TIME_WINDOW * 2 hours ago and the current time (or a supplied start and end time) and process all the commits in between that haven’t been processed yet.
  3. Configure the build configuration to allow a user to run it for a user-selected time range. (This will make it easy to re-run the build configuration for any commits that happen during a window when errors were happening.)

Epic DEVINF-261

Jira issue: CRDB-11341

Metadata

Metadata

Assignees

Labels

C-bugCode not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.T-dev-inf

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions