https://github.com/patridge/submoduleupdategenerator
Tool to create PRs to update Git submodules on a given repo.
https://github.com/patridge/submoduleupdategenerator
Last synced: 3 months ago
JSON representation
Tool to create PRs to update Git submodules on a given repo.
- Host: GitHub
- URL: https://github.com/patridge/submoduleupdategenerator
- Owner: patridge
- License: mit
- Created: 2017-07-24T16:10:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-12-14T16:58:24.000Z (over 3 years ago)
- Last Synced: 2025-01-01T10:25:29.430Z (5 months ago)
- Language: C#
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## How do I get it?
You can download/clone this repo and build it yourself, or you can download the [latest Release](https://github.com/patridge/SubmoduleUpdateGenerator/releases).
## What's it do?
This is a command-line utility to help update submodule references in GitHub repositories via pull requests.
Here's what it does at a high level
1. Checks what version the submodule repo is current at (for a given branch, defaulting to **master**)
2. Checks what hash/SHA on the submodule repo the parent repo currently has the submodule pointing to (for a given branch, defaulting to **master**)
3. If those versions differ via string check (not any sort of "newness" check)
1. Ensure the pull request creator has a fork of the parent repo, creating if necessary ([fork creation currently broken](https://github.com/patridge/SubmoduleUpdateGenerator/issues/1))
2. Create a `patch-#` branch on that fork to contain the submodule update changes
3. Updates the submodule target SHA to the latest on the submodule repo
4. Pushes changes to fork repo on GitHub
5. Creates a pull request on the parent repo's branch, compared to the fork repo's patch branch
## How did we get here?
This started as an experiment in learning Octokit to help out with a separate project during [Microsoft's One Week Hackathon](https://blogs.microsoft.com/firehose/2017/07/24/microsofts-one-week-hackathon-kicks-off-this-year-with-nonprofits-hacking-alongside-employees/).
## Feature Creep
- [ ] Allow PR from branch in parent repo rather than fork (e.g., you are not owner of parent, but have permission to branch)
## Sample command line params
To get some information about all the potential command line parameters, just run the program with the following command.
```bash
$ SubmoduleUpdateGenerator --help
```
These are likely not useful without customization.
### Some test repos
-owner=patridge -parent=GitPlayground-SampleParent -parentBranch=master -subOwner=patridge -sub=GitPlayground-SampleSubmodule -subBranch=master -pullOwner=your-username
### mono/monodevelop vs. mono/mono-tools submodule
-owner=mono -parent=monodevelop -parentBranch=master -subOwner=mono -sub=mono-tools -subBranch=master -pullOwner=patridge -dryrun=true