Replace git phr with GitHub CLI by ogajduse · Pull Request #521 · theforeman/theforeman-rel-eng

ogajduse · 2025-08-21T17:23:57Z

Summary

Replaces the custom git phr alias dependency with the standard GitHub CLI tool.

Changes

Updated bump_packaging to use gh pr create instead of git phr
Dependency documentation: Added GitHub CLI installation instructions to README

Benefits

Removes dependency on custom git aliases that users need to configure manually
Uses standard tooling available in distribution packages
Addresses git phr issue mentioned in Newbie installation issues #336

ekohl · 2025-08-22T10:27:50Z

bump_packaging

 fi

 git commit -m "Release $FULLVERSION"
+git push "$PACKAGING_GIT_REMOTE" "HEAD:$REMOTE_BRANCH"


This pushes straight to the target branch. A PR after this is pointless because it's effectively already merged.

Remember that phr is both a push (to your own fork) and a PR.

See #337 for an expansion of the aliases I use. Your PR here effectively implements what @evgeni suggested about using gh.

This pushes straight to the target branch. A PR after this is pointless because it's effectively already merged.

Remember that phr is both a push (to your own fork) and a PR.

I have missed the fact that $PACKAGING_GIT_REMOTE is the upstream repository. I'll fix it in the next patch.

ogajduse · 2025-08-22T17:29:38Z

I've pushed updates that address the issues identified in the review. Changes I've made:

Added GITHUB_USER setting with auto-detection via gh api user --jq .login (configurable in settings.local)
Added PACKAGING_FORK_REMOTE setting for configurable fork remote name
Use deterministic branch naming: release-$PROJECT-$FULLVERSION
Explicit fork creation with gh repo fork --remote-name

Benefits:

PR creation now creates a fork-to-upstream PR
Predictable remote names, branch names, and user identification
Other scripts can leverage the same fork setup and settings

ogajduse · 2025-08-22T17:38:24Z

I initially considered using just gh pr create without explicit fork management, but decided against it for several reasons:

gh pr create creates forks and remotes with unpredictable names, making it impossible to reliably reference the fork setup in other scripts.
The existing codebase uses GIT_REMOTE=upstream and PACKAGING_GIT_REMOTE=origin conventions. Auto-managed remotes could create inconsistent setups.
Other scripts need predictable settings they can reference. When things break, explicit steps are much clearer than auto-detection "magic."

ogajduse · 2025-09-09T16:42:52Z

I've used the script to bump rpm/3.16 to 3.16.0. Here is the script output if anyone is interested. One thing can be improved, though. That is the gh repo fork which prompts the user for input. That should ideally be auto-answered - the default option should be used.

+ git add packages/foreman/foreman packages/foreman/foreman-installer packages/foreman/foreman-proxy packages/foreman/foreman-release packages/foreman/foreman-selinux
+ git commit -m 'Release 3.16.0'
[rpm/release-foreman-3.16.0 93d057f80] Release 3.16.0
 13 files changed, 20 insertions(+), 15 deletions(-)
 delete mode 120000 packages/foreman/foreman-installer/foreman-installer-3.16.0-rc2.tar.bz2
 create mode 120000 packages/foreman/foreman-installer/foreman-installer-3.16.0.tar.bz2
 delete mode 120000 packages/foreman/foreman-proxy/foreman-proxy-3.16.0-rc2.tar.bz2
 create mode 120000 packages/foreman/foreman-proxy/foreman-proxy-3.16.0.tar.bz2
 delete mode 120000 packages/foreman/foreman-selinux/foreman-selinux-3.16.0-rc2.tar.bz2
 create mode 120000 packages/foreman/foreman-selinux/foreman-selinux-3.16.0.tar.bz2
 delete mode 120000 packages/foreman/foreman/foreman-3.16.0-rc2.tar.bz2
 create mode 120000 packages/foreman/foreman/foreman-3.16.0.tar.bz2
+ [[ true == true ]]
+ gh repo fork theforeman/foreman-packaging --remote-name origin
! ogajduse/foreman-packaging already exists
? Would you like to clone the fork? No
+ git push origin HEAD:rpm/release-foreman-3.16.0
Enumerating objects: 31, done.
Counting objects: 100% (31/31), done.
Delta compression using up to 14 threads
Compressing objects: 100% (18/18), done.
Writing objects: 100% (18/18), 2.02 KiB | 2.02 MiB/s, done.
Total 18 (delta 10), reused 0 (delta 0), pack-reused 0 (from 0)
remote: Resolving deltas: 100% (10/10), completed with 10 local objects.
remote: 
remote: Create a pull request for 'rpm/release-foreman-3.16.0' on GitHub by visiting:
remote:      https://github.com/ogajduse/foreman-packaging/pull/new/rpm/release-foreman-3.16.0
remote: 
To github.com:ogajduse/foreman-packaging.git
 * [new branch]          HEAD -> rpm/release-foreman-3.16.0
+ gh pr create --repo theforeman/foreman-packaging --title 'RPM: Release Foreman 3.16.0' --head ogajduse:rpm/release-foreman-3.16.0 --base rpm/3.16 --body 'Release Foreman 3.16.0'

Creating pull request for ogajduse:rpm/release-foreman-3.16.0 into rpm/3.16 in theforeman/foreman-packaging

https://github.com/theforeman/foreman-packaging/pull/12455

ekohl · 2025-10-29T17:35:25Z

settings

 GIT_DEVELOP_BRANCH=develop
 GIT_STABLE_BRANCH="${VERSION}-stable"
 GITHUB_NAMESPACE=theforeman
+GITHUB_USER="${GITHUB_USER:-$(gh api user --jq .login)}"


This performs a network request and I'd suggest to avoid that. Perhaps just assume the GITHUB_USER is $USER?

Since we're including gh in the script, the network requests are going to be performed anyway

Not always. Remember that settings is always loaded, also for commands where git isn't involved.

True. In that case, there's also an option to keep this API call but do it only when needed.

I'd still lean to keeping it simple:

Suggested change

GITHUB_USER="${GITHUB_USER:-$(gh api user --jq .login)}"

GITHUB_USER="${GITHUB_USER:-$USER}"

Then users can override it in their local settings if they want. Either statically or dynamically with gh api user.

ogajduse · 2025-11-05T15:57:37Z

@ekohl Mind revisiting?

I can confirm the patch works nicely, I've used it to create

README.md

bump_packaging

ekohl · 2025-12-05T14:44:54Z

settings

+GITHUB_USER="${GITHUB_USER:-$USER}"
 PACKAGING_DIR="$GIT_DIR/foreman-packaging"
 PACKAGING_GIT_REMOTE=origin
+PACKAGING_FORK_REMOTE="${PACKAGING_FORK_REMOTE:-origin}"


These both default to origin, but is that really what we want? You'll end up running gh repo fork theforeman/foreman-packaging --remote-name "origin" but there is already an origin. Doesn't it make more sense to default to the GH username?

Suggested change

PACKAGING_FORK_REMOTE="${PACKAGING_FORK_REMOTE:-origin}"

PACKAGING_FORK_REMOTE="${PACKAGING_FORK_REMOTE:-${GITHUB_USER}}"

That totally makes sense. Addressed.

ekohl · 2026-01-31T14:15:24Z

bump_packaging

 if [[ $PACKAGING_PR == true ]] ; then
-	git phr -m "Release $FULLVERSION" -b "$REMOTE_BRANCH"
+	# Ensure fork exists with configured remote name
+	gh repo fork theforeman/foreman-packaging --remote-name "$PACKAGING_FORK_REMOTE"


When I try this out locally I see:

$ gh repo fork theforeman/foreman-packaging --remote-name ekohl ! ekohl/foreman-packaging already exists ? Would you like to clone the fork? (y/N)

So this is an interactive command and that goes against the spirit of the tooling. I don't see any option to make gh non-interactive and quiet.

That's a good point. I stumbled upon GH_PROMPT_DISABLED

GH_PROMPT_DISABLED: set to any value to disable interactive prompting in the terminal.

$ GH_PROMPT_DISABLED=1 gh repo fork theforeman/pulpcore-packaging --remote-name ekohl ✓ Created fork ogajduse/pulpcore-packaging $ echo $? 0 $ GH_PROMPT_DISABLED=1 gh repo fork theforeman/pulpcore-packaging --remote-name ekohl ! ogajduse/pulpcore-packaging already exists $ echo $? 0

Updated.

ekohl · 2026-01-31T14:16:08Z

bump_packaging

+	# Ensure fork exists with configured remote name
+	gh repo fork theforeman/foreman-packaging --remote-name "$PACKAGING_FORK_REMOTE"
+
+	# Push to fork


This may be nitpicking, but does the comment really add anything? I'd think that the command it self-explanatory.

Agreed. Comment removed.

- Replace git phr alias with gh pr create in bump_packaging script - Change push behavior to always push before creating PR - Add GitHub CLI installation documentation to README - Addresses git phr dependency issue mentioned in theforeman#336 This removes the dependency on custom git aliases and uses the standard GitHub CLI tool that's available in distribution packages.

- Add GITHUB_USER setting with auto-detection via gh CLI - Add PACKAGING_FORK_REMOTE setting for configurable fork remote name - Fix git push/PR creation logic in bump_packaging: - Remove direct push to target branch when creating PRs - Use deterministic branch names: release-$PROJECT-$FULLVERSION - Explicitly manage fork creation with gh repo fork - Use configured GITHUB_USER and PACKAGING_FORK_REMOTE settings - Document new settings in README - Ensures predictable behavior and reusable fork setup

- Change PACKAGING_FORK_REMOTE default from 'origin' to GITHUB_USER - Simplify git push to use --set-upstream with plain HEAD - Update documentation to reflect actual default behavior

ogajduse · 2026-02-10T19:50:49Z

Rebased onto master

ekohl requested changes Aug 22, 2025

View reviewed changes

pr-processor bot added the Waiting on contributor label Aug 22, 2025

lhellebr approved these changes Oct 29, 2025

View reviewed changes

ekohl reviewed Oct 29, 2025

View reviewed changes

ogajduse force-pushed the feature/replace-git-phr branch 2 times, most recently from 98f6be4 to 56c9e72 Compare November 5, 2025 15:55

ogajduse requested a review from ekohl November 5, 2025 15:56

ekohl reviewed Dec 5, 2025

View reviewed changes

ogajduse requested a review from ekohl January 15, 2026 15:31

ogajduse removed the Waiting on contributor label Jan 15, 2026

ekohl reviewed Jan 31, 2026

View reviewed changes

ogajduse requested a review from ekohl February 2, 2026 20:58

ogajduse added 6 commits February 10, 2026 20:50

Differentiate branches based on rpm/deb flavor

af2e042

Reuse FEATURE_BRANCH across the script

299b07c

Default fork remote to GitHub username

a4ed470

- Change PACKAGING_FORK_REMOTE default from 'origin' to GITHUB_USER - Simplify git push to use --set-upstream with plain HEAD - Update documentation to reflect actual default behavior

Run in non-interactive mode

0a27c76

ogajduse force-pushed the feature/replace-git-phr branch from e181d42 to 0a27c76 Compare February 10, 2026 19:50

	GITHUB_USER="${GITHUB_USER:-$(gh api user --jq .login)}"
	GITHUB_USER="${GITHUB_USER:-$USER}"

	PACKAGING_FORK_REMOTE="${PACKAGING_FORK_REMOTE:-origin}"
	PACKAGING_FORK_REMOTE="${PACKAGING_FORK_REMOTE:-${GITHUB_USER}}"

Conversation

ogajduse commented Aug 21, 2025

Summary

Changes

Benefits

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ogajduse commented Aug 22, 2025

Uh oh!

ogajduse commented Aug 22, 2025

Uh oh!

ogajduse commented Sep 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ogajduse commented Nov 5, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ogajduse commented Feb 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants