Add script for checking the status of the backports by andreslucena · Pull Request #11065 · decidim/decidim

andreslucena · 2023-06-19T14:05:25Z

🎩 What? Why?

This PR introduces a companion for the bin/backporter script. The idea is to be able to see which Pull Requests with the type: fix label have backport PRs already created and related to them.

$ ./bin/backports_checker 
No value provided for required options '--github-token', '--last-version-number'
$ ./bin/backports_checker  --help
Usage:
  backports_checker --github-token=GITHUB_TOKEN --last-version-number=LAST_VERSION_NUMBER

Options:
  --github-token=GITHUB_TOKEN                # Required. Github Personal Access Token (PAT). It can be obtained from https://github.com/settings/tokens/new. You will need to create one with `public_repo` access.
  --last-version-number=LAST_VERSION_NUMBER  # Required. The version number of the last supported version that you want to do the backports to. It must have the format MAJOR.MINOR.
  [--days-to-check-from=N]                   # How many days we will check from.
                                             # Default: 90

Backports checker. Shows the status of the pull requests opened in the last days

The output by default is for the terminal. It uses a color code to differentiate the status of the Pull Requests, following the colors of GitHub:
- Purple: closed with a merge
- Red: closed without being merge
- Green: opened without being merge

Example command:

$ ./bin/backports_checker --github-token=<GH_PAT_TOKEN> --days_to_check_from=30 --last_version_number=0.27

There's also a CSVReporter, that will allow us in the future to make a TUI or something like that that will allow us to use the output of this script as the input for the backporter script (see #9281)

📌 Related Issues

Related to Add script for generating backports of PRs #9281

Testing

Run the script ./bin/backports_checker

♥️ Thank you!

…ce Base class

…the other classes

…c example

…ackport list

It is on how many days since the PR was **updated**, not **created**, nor **merged**.

alecslupu · 2023-07-19T06:50:12Z

I was just looking through this PR (from user point of view), and i have a few suggestions:

When running ./bin/backports_checker --github-token ... i have received uninitialized constant ActiveSupport::IsolatedExecutionState (NameError) error, but works fine when using ./bin/bundle
The title field, should display only a certain number of characters. If the PR is Longer, we should truncate :

I am already thinking about a command argument that could be added, so that we can schedule running weekly the task in github actions.

alecslupu · 2023-07-19T07:03:17Z

On the other hand, when running

./bin/bundle exec ./bin/backports_checker --days_to_check_from=360 --github-token=... --last-version-number=0.27

I came across:

| #9791 | Fix leaking emails on admin user search controller                                  |      None      |      None      |

#9791 is already backported, but some reason is being marked as "to do".

andreslucena · 2023-07-19T07:32:27Z

When running ./bin/backports_checker --github-token ... i have received uninitialized constant ActiveSupport::IsolatedExecutionState (NameError) error, but works fine when using ./bin/bundle

Mmmm that one is weird. I can confirm that the command that I'm using is ./bin/backports_checker. There's probably a difference between our environments or something like that.

As far as I know I try to not use Rails APIs, and if I use them I require them, as we're outside the Rails environment

The title field, should display only a certain number of characters. If the PR is Longer, we should truncate :

I was just giving it one last look and found that one too. It's fixed on c11ce71

#9791 is already backported, but some reason is being marked as "to do".

I think that's because the title was missing the "v" in "v0.26". The big assumption of this script is that the backports need to comply with the titles created with the "bin/backporter" script, so I can extract it all with the GitHub API. I guess I could have checked it with the git CLI too, but well, I went with this other approach as it was what we usually do manually to check if the backport was done or not.

I fixed those titles and now it should appear as backported.

andreslucena · 2023-07-19T07:34:45Z

I fixed those titles and now it should appear as backported.

Confirmed:

| #9791 | Fix leaking emails on admin user search controller                                  |      #9796     |      #9797     |

alecslupu

Tested Locally, LGTM

andreslucena added the type: internal PRs that aren't necessary to add to the CHANGELOG for implementers label Jun 19, 2023

andreslucena marked this pull request as draft June 21, 2023 07:09

This was referenced Jun 23, 2023

Check for supported locale in Emoji picker #11079

Merged

Fix configuration param and documentation links in CSP #11098

Merged

andreslucena force-pushed the chore/backporter-checker branch 2 times, most recently from ccc8418 to fa7a108 Compare July 5, 2023 07:58

andreslucena marked this pull request as ready for review July 5, 2023 08:34

andreslucena force-pushed the chore/backporter-checker branch from a128f36 to 1ec6521 Compare July 5, 2023 11:09

andreslucena requested a review from a team July 5, 2023 11:41

andreslucena marked this pull request as draft July 18, 2023 16:40

andreslucena added 20 commits July 18, 2023 18:43

Extract ByIssueId class on Decidim::GithubManager::Querier to introdu…

7c3af4f

…ce Base class

Introduce Decidim::GithubManager::Querier::ByLabel

883055a

Introduce Decidim::GithubManager::Querier::RelatedIssues

00c1f64

Add exclude_label feature in ByLabel class

9c5a06f

Prefer usage of id key in RelatedIssues class for consistency with …

b522520

…the other classes

Remove hardcoded days constant in ByLabel

2d6ff62

Differentiate when a PR was merged or closed w/o merge

a762879

Clean-up spec

3660123

Fix spec

79ee1bb

Fix yardocs

ec8d875

Move raising InvalidMetadataError exception logic to Base class

2aeecf3

Add missing requires

7d11c22

Permit multiple excluded labels when querying by label

5bbfe42

Add CSV and CLI backports reporters

2be6c25

Add CLI for backports_checker

c101455

Remove hardcoded version numbers in Reports

f3016de

Remove CSV report from output

2e5f646

Fix rubocop offense for Rails/Date

70ff44f

Fix rubocop offense for Style/NegatedIfElseCondition

143bb7c

Fix rubocop offense for Layout/SpaceInsideArrayLiteralBrackets

810c5ee

andreslucena added 12 commits July 18, 2023 18:43

Fix rubocop offense for Rails/TimeZoneAssignment

bac37af

Add spec for checking that the backport branch is converted correctly

77bdc95

Prefer usage of subject instead of memoized manager variable for rspe…

71206f2

…c example

Sanitize user-supplied parameter for preventing command-line injections

7bfffd8

Check if the pull requests were merged before showing in the PRs to b…

f399672

…ackport list

Improve docs on ByLabel class with all the conditions

b6b96c5

Tune style of CLIReport

84687ee

Fix bug when there are much events in the Timeline for RelatedIssues

18dc23b

Add colors explanations in CLI help

530bc26

Fix documentation on :days_to_check_from

8aeb1d6

It is on how many days since the PR was **updated**, not **created**, nor **merged**.

Add pagination support for GitHub querier

828cc39

Check that the days_to_check_from complies with the merged_at date

c7e6607

andreslucena force-pushed the chore/backporter-checker branch from 2f362c0 to c7e6607 Compare July 18, 2023 16:44

andreslucena added 2 commits July 18, 2023 18:50

Add instructions for how to use the auth token from the gh CLI tool

ae2b12e

Fix rubocop offense for Style/PreferredHashMethods

6799e11

andreslucena added 2 commits July 19, 2023 09:10

Fix bug on CLI reporter when the title is really long

c11ce71

Improve specs for related_issues on CLI reporter

a08058b

alecslupu mentioned this pull request Jul 19, 2023

Analize the PRs in the last year to consider new backports. #11233

Closed

Fix bug on CLI reporter when the ID is short

adb2a8b

andreslucena marked this pull request as ready for review July 19, 2023 07:43

alecslupu approved these changes Jul 24, 2023

View reviewed changes

alecslupu merged commit 033111e into develop Jul 24, 2023

alecslupu deleted the chore/backporter-checker branch July 24, 2023 11:46

andreslucena mentioned this pull request Jul 24, 2023

Fix bug with sanitize_branch method on bin/backports script #11337

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add script for checking the status of the backports#11065

Add script for checking the status of the backports#11065
alecslupu merged 37 commits intodevelopfrom
chore/backporter-checker

andreslucena commented Jun 19, 2023 •

edited

Loading

Uh oh!

alecslupu commented Jul 19, 2023

Uh oh!

alecslupu commented Jul 19, 2023

Uh oh!

andreslucena commented Jul 19, 2023

Uh oh!

andreslucena commented Jul 19, 2023

Uh oh!

alecslupu left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

andreslucena commented Jun 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎩 What? Why?

📌 Related Issues

Testing

Uh oh!

alecslupu commented Jul 19, 2023

Uh oh!

alecslupu commented Jul 19, 2023

Uh oh!

andreslucena commented Jul 19, 2023

Uh oh!

andreslucena commented Jul 19, 2023

Uh oh!

alecslupu left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

andreslucena commented Jun 19, 2023 •

edited

Loading