https://github.com/ivanbakel/submodule-dependency
GitHub action to checkout submodule changes that are required for a pull request
https://github.com/ivanbakel/submodule-dependency
Last synced: 5 months ago
JSON representation
GitHub action to checkout submodule changes that are required for a pull request
- Host: GitHub
- URL: https://github.com/ivanbakel/submodule-dependency
- Owner: ivanbakel
- Created: 2020-06-09T19:47:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-14T23:49:57.000Z (over 1 year ago)
- Last Synced: 2025-09-17T22:53:42.713Z (9 months ago)
- Language: TypeScript
- Size: 48.8 KB
- Stars: 0
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `submodule-dependency` - Mark submodule pull requests as requirements
The `submodule-dependency` action allows PR authors to mark pull requests against submodules as necessary changes in order to compile a new pull request. The action automatically checks out those submodule changes, based on the contents of the pull request body.
## Declaring a dependency
A submodule pull-request dependency can be declared by putting "Requires \/\#\" anywhere in the pull request body. You can also use "Depends on" with the same format.
## Limitations
* The action assumes that the corresponding submodule is located in a folder of the same name in the root directory of the repository.
* The action assumes that the dependency can be fetched over HTTPS.
* The action assumes that the `pullfrom` remote name is not in use in the submodule.