Skip to content

Commit ffc1819

Browse files
committed
Add a section on known limitations
1 parent b3e603b commit ffc1819

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,16 @@ await commitFilesFromBuffers({
286286
});
287287
```
288288

289+
## Known Limitations
290+
291+
Due to using the GitHub API to make changes to repository contents,
292+
there are some things it's not possible to commit,
293+
and where using the Git CLI is still required.
294+
295+
- Executable files
296+
- Symbolic Links
297+
- Submodule changes
298+
289299
## Other Tools / Alternatives
290300

291301
- [planetscale/ghcommit](https://github.com/planetscale/ghcommit) - Go library for committing to GitHub using graphql

0 commit comments

Comments
 (0)