xxmime/Accelerated GitHub Checkout
Fast repository checkout using intelligent mirror proxy services for improved download speeds
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| repository | Repository name with owner (e.g., owner/repo) | no | ${{ github.repository }} |
| ref | The branch, tag or SHA to checkout | no | "" |
| token | GitHub token for authentication | no | ${{ github.token }} |
| path | Relative path under workspace to place the repository | no | . |
| enable-acceleration | Enable proxy acceleration for faster downloads | no | true |
| mirror-url | Specific mirror service URL (e.g., https://ghproxy.com) | no | "" |
| github-proxy-url | Alias for mirror-url. Specific mirror service URL (e.g., https://ghproxy.com) | no | "" |
| mirror-timeout | Mirror connection timeout in seconds | no | 30 |
| fallback-enabled | Enable fallback to direct GitHub download if mirror fails | no | true |
| download-method | Download method: auto, mirror, direct, or git | no | auto |
| retry-attempts | Number of retry attempts for failed downloads | no | 3 |
| fetch-depth | Number of commits to fetch (0 for all history) | no | 1 |
| clean | Whether to execute git clean before fetching | no | true |
| verbose | Enable verbose logging for debugging | no | false |
Outputs
| name | description |
|---|---|
| ref | The branch, tag or SHA that was checked out |
| commit | The commit SHA that was checked out |
| download-method | The actual download method used (mirror/direct/git) |
| mirror-used | The mirror service URL that was used (if any) |
| download-time | Total download time in seconds |
| download-speed | Average download speed in MB/s |
| download-size | Total downloaded size in bytes |
| success | Whether the checkout operation was successful |
| fallback-used | Whether fallback to direct download was used |
| error-message | Error message if the operation failed |
| error-code | Error code for programmatic error handling |