github / github/codeql-action-sync-tool

Support limiting of batch sizes

Open
#180 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
52
Forks
28
PR merge metrics
No merged PRs in 30d

Description

Hey,

the actions sync tool is supporting the batch-size parameter.

> batch-size (optional) Number of refs to push in each batch. Default is 0 (no batching). Use a value like 100 if pushing fails for large repositories with many branches and tags.

As of the release notes of codeql action sync tool, some code regarding the batch sizes were merged.

Image

But so far, the tool doesnt seem to support the batch size parameter.

```
unknown flag: --batch-size

Usage:
codeql-action-sync sync [flags]

Flags:
--actions-admin-user string The name of the Actions admin user. (default "actions-admin")
--destination-repository string The name of the repository to create on GitHub Enterprise. (default "github/codeql-action")
--destination-token string A token to access the API on the GitHub Enterprise instance (can also be provided by setting the CODEQL_ACTION_SYNC_TOOL_DESTINATION_TOKEN environment variable).
--destination-url string The URL of the GitHub Enterprise instance to push to.
--force Replace the existing repository even if it was not created by the sync tool.
-h, --help help for sync
--push-ssh Push Git contents over SSH rather than HTTPS. To use this option you must have SSH access to your GitHub Enterprise instance configured.
--source-token string A token to access the API of GitHub.com. This is normally not required, but can be provided if you have issues with API rate limiting.

Global Flags:
--cache-dir string The path to a local directory to cache the Action in. (default "/azp/_work/1/s/cache")
--insecure Allow insecure server connections when using TLS

```

Would it be possible to have batch-size limiter also in the codeql-action-sync-tool?
Would really appreciate it, as the codeql sync often fails.

Contributor guide

Open the contributing guide

Research direction

Start by locating the sync command's flag definitions and the existing batch-size-related code referenced in the release notes. Reproduce the reported unknown flag with `codeql-action-sync sync --help`; done means the command accepts `--batch-size` and uses it to limit refs pushed in each batch.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.