Update definition of a change (merged PR)

[russellkan]

Issue

Some of my merged PRs don't show up in the change_id relation of relevant problem reports in the generated history.yml document despite being linked. Due to this, the generated documents are missing many of the change requests and problem reports relevant to a certain release.

Cause

I noticed that the module defines a change as one that is merged to master and also not labeled obsolete:

rdm/rdm/project_management/github.py

Line 77 in 5c45538

is_merged = pull_request.merged and pull_request.base.ref == 'master'

For one of the projects, we have PRs pointed to a branch named after the release version (e.g. v1.5). It also seems like this would fail for any repository where the base branch isn't master (like newer repos with main).

Proposed solution

There are a few options I thought of. The easiest would be to simply remove the base ref check pull_request.base.ref == 'master'. I'm not sure if this would cause any side effects, but it fixes the issue that I was having.

Alternatively, we could implement a way to manually specify the base branch either in the config.yml used by rdm pull or as an option for the command itself.

[johndgiese]

@russellkan this is a great point. I'm surprised this issue hasn't come up before. Whatever solution we come up with for this should not only solve the problems you mention but also make it possible to grab the history of changes since the last release. E.g., between v1.1 and v1.2.