Mirror of space-wizards/submodule-dependency
Find a file
DrSmugleaf c236e9954c
Merge pull request #2 from Cyberboss/patch-1
Make the action work with `pull_request_target`
2024-02-02 13:36:05 -08:00
dist Fix incorrect dependencies in TS export 2021-02-22 14:43:01 +01:00
src Make the action work with pull_request_target 2024-02-02 14:07:20 -05:00
.gitignore Initial commit of submodule updater action 2020-06-09 20:33:46 +01:00
action.yml Update action.yml 2021-02-21 16:33:22 +01:00
package-lock.json Bump @actions/core from 1.2.4 to 1.2.6 2020-10-01 17:39:50 +00:00
package.json Add user.email to GitHub identity step 2021-02-22 14:10:48 +01:00
README.md Make the supported formats slightly more consistent 2021-02-21 16:45:22 +01:00
tsconfig.json Initial commit of submodule updater action 2020-06-09 20:33:46 +01:00

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 <GitHub user>/<repository>#<PR number>" anywhere in the pull request body. You can also use "Depends on" with the same format.

Supported formats

Requires user/repo#id

Requires https://github.com/user/repo/pull/id

Requires [user/repo#id](https://github.com/user/repo/pull/id)

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.