Skip to content

Add a section on known limitations #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 10, 2025
Merged

Add a section on known limitations #42

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffc1819
Add a section on known limitations
s0 May 9, 2025
106b23e
Merge branch 'main' into limitations
s0 May 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,16 @@ await commitFilesFromBuffers({
});
```

## Known Limitations

Due to using the GitHub API to make changes to repository contents,
there are some things it's not possible to commit,
and where using the Git CLI is still required.

- Executable files
- Symbolic Links
- Submodule changes

## Other Tools / Alternatives

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