Skip to content

Update README.md with known limitations #18

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
aSemy merged 1 commit into from
Jun 18, 2026
Merged

Update README.md with known limitations #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@ Argh is perfect for prototyping, or sharing internal libraries.

Argh is an experimental prototype. Please try it out, feedback is welcome!

#### Known limitations

##### Limit on attached files.

Argh has a limit on the number of modules it can publish. See [Issue #17](https://github.com/adamko-dev/argh/issues/17).

GitHub Releases has a hard limit on the number of attached files. Argh takes steps to limit the number of published files - approximately 8 files per published module - but larger projects will run into this limit.

For example, a Gradle project with 10 subprojects, each with 10 Kotlin Multiplatform targets (hence each subproject has 10 modules), will publish approximately 800 files.

##### Private repositories

Argh only supports resolving releases from public repositories - see [Issue #13](https://github.com/adamko-dev/argh/issues/13).

Publishing to private GitHub releases is possible, but consuming them from Gradle is not possible because GitHub does not provide an API for this, and Gradle does not support custom repositories. Consuming from Maven is theoretically possible, but is not implemented.

### Guide for Publishers

##### Requirements
Expand Down
Loading