From: Christian Marangi <ansuelsmth@gmail.com>
Date: Thu, 15 Feb 2024 20:56:45 +0000 (+0100)
Subject: github-merge-pr: add generic enough instruction on how to use the script
X-Git-Url: http://git.openwrt.org/?a=commitdiff_plain;h=f4abd9b29596ce1afa26f5b43bd8597127f72252;p=maintainer-tools.git

github-merge-pr: add generic enough instruction on how to use the script

Add generic enough instruction on how to use the github-merge-pr script.

Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
---

diff --git a/github-merge-pr.sh b/github-merge-pr.sh
index 6d0dbe5..e22f3df 100755
--- a/github-merge-pr.sh
+++ b/github-merge-pr.sh
@@ -1,5 +1,13 @@
 #!/bin/bash
 
+# How to setup the repository to make this correctly work
+# 1. Clone repo and make sure you can correctly push to that
+#    (example with openwrt main repo you need to use ssh remote url)
+# 2. Make sure you can correctly push and force push to the github
+#    repository
+#
+# Usage: github-merge-pr.sh PR_NUMBER BRANCH
+
 # Github repository, just the name/repo part, no .git suffix, no base url!
 REPO="openwrt/openwrt"