Add backport tool by arogge · Pull Request #1639 · bareos/bareos

arogge · 2023-12-20T14:05:41Z

This PR adds a pr-tool subcommand to assist when backporting pull requests to previous releases.
It also updates all the python dependencies in pip-tools.

See devtools/pr-tool backport --help for help.
Don't forget to cd devtools/pip-tools; pipenv --rm; pipenv sync to get updated dependencies.

TODO:

decide on a method to generate the branch name
~~allow users to pass a custom branch-name on pr-tool backport create?~~
decide where to put backport_pr_template.md
improve error handling when local tracking branches are missing or point to the wrong remote

Please check

Short description and the purpose of this PR is present above this paragraph
Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General

Is the PR title usable as CHANGELOG entry?
Purpose of the PR is understood
Commit descriptions are understandable and well formatted

Source code quality

Source code changes are understandable
Variable and function names are meaningful
Code comments are correct (logically and spelling)
Required documentation changes are present and part of the PR

arogge · 2023-12-22T13:43:44Z

I'm not sure putting the template into .github/ in the backport-branch ist great. Maybe we should put it somewhere in the pr_tool python module?

bruno-at-bareos · 2024-01-05T09:13:05Z

Testing the tools.

At step create it is not clear if the --into is mandatory or not, and if you need to have an existing branch already (seems so)

pr-tool backport create --into dev/bruno/bareos-23/backport-1646-fix-python-bareos-add-af6_familly-support 1646
Traceback (most recent call last):
  File "/ioda/home/bruno/.local/share/virtualenvs/pip-tools-chozOdxA/bin/pr-tool", line 8, in <module>
    sys.exit(main())
             ^^^^^^
  File "/ioda/home/bruno/bareos/git/bareos/devtools/pip-tools/pr_tool/main.py", line 670, in main
    target_branch = backport.resolve_target_branch(repo, git_remote, args.into)
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/ioda/home/bruno/bareos/git/bareos/devtools/pip-tools/pr_tool/backport.py", line 68, in resolve_target_branch
    remote_branch = local_branch.tracking_branch()
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'tracking_branch'

I've tried without any parameter

pr-tool backport create 1646
ERROR: root: add-backport-tool does not track a branch on remote upstream

Ok after a few tries I've found that

 pr-tool backport create --help
usage: pr-tool backport create [-h] [--into <base_branch>] [--all] <pr number>

positional arguments:
  <pr number>           GitHub PR number of the PR to backport from

options:
  -h, --help            show this help message and exit
  --into <base_branch>  Branch into which the backport should be done (defaults to current branch)
  --all                 pick all commits

Give all the correct details, I was just a bit confuse about the --into ( for me a --on or --from would have make more sense, but I will adapt to --into :-) )

Work well, after 10 minutes playing with. A nice and great enhancement into our workflow.

sebsura

This is a great tool.

devtools/pip-tools/pr_tool/main.py

devtools/pip-tools/pr_tool/github.py

bruno-at-bareos · 2024-01-23T10:57:41Z

@arogge template need to remove the blank line so list is not double line

sebsura

Looks good to me. I added some comments.

devtools/pip-tools/pr_tool/backport.py

devtools/pip-tools/pr_tool/backport_pr_template.md

devtools/pip-tools/pr_tool/github.py

devtools/pip-tools/pr_tool/main.py

sebsura

Thanks for you work! Ill approve of it now, but please do update the copyright headers with the correct year!

devtools/pip-tools/pr_tool/backport.py

devtools/pip-tools/pr_tool/main.py

devtools/pip-tools/pr_tool/github.py

devtools/pip-tools/pr_tool/backport.py

This patch adds the new subcommand "backport" to pr-tool which supports the following operations: pr-tool backport create <pr> [--into <branch>] create a new backport-branch based on <branch> (or the current branch) and cherry-pick commits from <pr> pr-tool backport cherry-pick [--reset] Re-run the cherry-pick from the original PR, optionally automatically resetting the base-branch pr-tool backport publish [--dry-run] create the backport PR on GitHub

Based on GitHub's boilerplate for Python, we now ignore some build/install artifacts that pipenv might be creating.

This was previously taken from the backport-branch, which is probably not what we want.

detect the "feature" label on the PR and put the changelog record into the Added section.

previously we only considered the first URL for a remote. With this change we ignore remotes that have multiple URLs configured and emit a warning. Remotes with multiple URLs are only used if you want to push to multiple locations at once, which is probably not what `pr_tool backport` should be doing.

Add a positive_int type for argparse and use that for the pr number parameter.

arogge added enhancement requires backport to 21 requires backport to 22 requires backport to 23 labels Dec 20, 2023

arogge mentioned this pull request Dec 20, 2023

build(deps): bump gitpython from 3.1.32 to 3.1.37 in /devtools/pip-tools #1571

Closed

arogge added the nobuild label Dec 20, 2023

sebsura reviewed Jan 5, 2024

View reviewed changes

devtools/pip-tools/pr_tool/main.py Outdated Show resolved Hide resolved

devtools/pip-tools/pr_tool/github.py Show resolved Hide resolved

devtools/pip-tools/pr_tool/github.py Outdated Show resolved Hide resolved

pstorz removed requires backport to 21 requires backport to 22 requires backport to 23 labels Jan 23, 2024

pstorz assigned sebsura Jan 23, 2024

sebsura requested changes Jan 29, 2024

View reviewed changes

arogge force-pushed the add-backport-tool branch from d49ce31 to acf9661 Compare January 30, 2024 09:07

sebsura approved these changes Jan 31, 2024

View reviewed changes

devtools/pip-tools/pr_tool/backport.py Outdated Show resolved Hide resolved

devtools/pip-tools/pr_tool/main.py Show resolved Hide resolved

devtools/pip-tools/pr_tool/github.py Outdated Show resolved Hide resolved

arogge marked this pull request as ready for review February 15, 2024 11:33

arogge force-pushed the add-backport-tool branch from 7ec52cb to bcd2777 Compare February 15, 2024 14:36

sebsura removed the nobuild label Feb 19, 2024

bruno-at-bareos reviewed Feb 19, 2024

View reviewed changes

devtools/pip-tools/pr_tool/backport.py Outdated Show resolved Hide resolved

arogge added 9 commits February 27, 2024 09:14

pr-tool: move github functionality into separate module

b3579af

devtools: update python dependencies

2fd7450

devtools: add .gitignore to pip-tools directory

c41a3c3

Based on GitHub's boilerplate for Python, we now ignore some build/install artifacts that pipenv might be creating.

pr_tool: use backport template from module

8d06f37

This was previously taken from the backport-branch, which is probably not what we want.

update backport pr template

acbadee

devtools: update python dependencies (again)

98647a4

pr_tool: auto-select Added section based on labels

1c9d836

detect the "feature" label on the PR and put the changelog record into the Added section.

arogge added 11 commits February 27, 2024 09:14

pr_tool: make resolve_target_branch() safer

5ca7b2b

pr_tool: ignore whitespace in cherry-pick lines

13116ac

pr_tool: give nicer error for non-existant pr

7895eda

pr_tool: give error when user's remote is not found

98a62c7

pr_tool: make get_pr_info() return None on error

07dbe94

pr_tool: fail when original PR data is not available

6ad970b

pr_tool: open temporary files with w+ instead of r+

33d12f5

pr_tool: update backport-template

cec0999

pr_tool: make Gh() initializer nicer

ce764fd

pr_tool: use new positive_int type for pr number

1b7ea4f

Add a positive_int type for argparse and use that for the pr number parameter.

apply bareos-check-sources

f9aee0d

arogge force-pushed the add-backport-tool branch from bcd2777 to 5ca8a79 Compare February 27, 2024 08:16

pr-tool backport: improve logging

18e7aa1

arogge force-pushed the add-backport-tool branch from 5ca8a79 to 18e7aa1 Compare February 29, 2024 08:44

Update CHANGELOG.md

b1de0ac

arogge merged commit 48271b5 into bareos:master Mar 6, 2024

Conversation

arogge commented Dec 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Please check

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

General

Source code quality

Uh oh!

arogge commented Dec 22, 2023

Uh oh!

bruno-at-bareos commented Jan 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sebsura left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bruno-at-bareos commented Jan 23, 2024

Uh oh!

sebsura left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sebsura left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

arogge commented Dec 20, 2023 •

edited

Loading

bruno-at-bareos commented Jan 5, 2024 •

edited

Loading