readme

README.md

@@ -0,0 +1,32 @@
+Scripts to sync git submodules of a project via pull requests
+
+The git repo in the current directory is expected to have at least
+one remote pointing to the target project. If that repo is not
+writable, another one can be used for pushing.
+
+create a config file in the current directory
+```
+# name of the remote to push to as repored by `git remote`
+PUSH_REMOTE="joesix"
+# username on gitea
+PR_SRC_USER="joesix"
+# target project for pull requests
+PR_PROJECT="mold"
+# target repo on gitea
+PR_REPO="core"
+# token
+TOKEN="deadbeef"
+# the url for cloning the project. Packages may use an url relative
+to that.
+PACKAGE_BASE_URL="https://gitea.opensuse.org/mold/core.git"
+# relative url for new packages
+PACKAGE_RELATIVE_URL="../../rpm"
+# remote to to send pull requests to
+REMOTE="origin"
+# base branch of the target remote
+BASE_BRANCH="main"
+# optional: fixed date or a filename prefixed with @ to get a stable date for testing
+DATE="@token"
+# optional: an OBS project with a list of packages
+RING0API="https://api.opensuse.org/public/source/openSUSE:Factory:Rings:0-Bootstrap"
+```