Skip to content

docs: document gitproxy GITHUB_MIRROR and GITPROXY_ADDRESS#925

Merged
igorpecovnik merged 1 commit into
mainfrom
docs/gitproxy-mirror
Jun 10, 2026
Merged

docs: document gitproxy GITHUB_MIRROR and GITPROXY_ADDRESS#925
igorpecovnik merged 1 commit into
mainfrom
docs/gitproxy-mirror

Conversation

@igorpecovnik

@igorpecovnik igorpecovnik commented Jun 10, 2026

Copy link
Copy Markdown
Member

Documents the newly added gitproxy value for GITHUB_MIRROR and the companion GITPROXY_ADDRESS switch.

gitproxy routes all GitHub source clones through a pass-through git proxy whose full base URL is given in GITPROXY_ADDRESS. It is auto-selected when a self-hosted CI runner exports GITPROXY_ADDRESS (sourced from the NetBox git_proxy custom field via github-runners.jq).

Related changes:

  • armbian/build: gitproxy case + auto-select in main-config.sh, GITPROXY_ADDRESS forwarded into the build container
  • armbian/os: runner-info step exports git_proxy as GITPROXY_ADDRESS
  • armbian/armbian.github.io: git_proxy field added to github-runners.jq

Create docs preview on PR

Documentation website preview will be available shortly:


 Open WWW preview 

Add the gitproxy value to GITHUB_MIRROR and a GITPROXY_ADDRESS switch
entry, covering the pass-through git proxy used by self-hosted CI
runners.

Signed-off-by: Igor Pecovnik <igor@armbian.com>
@github-actions github-actions Bot added size/small PR with less then 50 lines Needs review Seeking for review labels Jun 10, 2026
@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9f98b071-8f8b-460a-bb6c-454591d766ac

📥 Commits

Reviewing files that changed from the base of the PR and between 114ef02 and 75b326b.

📒 Files selected for processing (1)
  • docs/Developer-Guide_Build-Switches.md

Disabled knowledge base sources:

  • Jira integration is disabled

You can enable these sources in your CodeRabbit configuration.


Walkthrough

This PR updates the Developer Guide documentation for build switches. The GITHUB_MIRROR parameter now includes a new gitproxy option that enables pass-through git proxy functionality. A corresponding GITPROXY_ADDRESS parameter has been documented to specify the full base URL used to replace https://github.com during source clones. The changes expand the existing mirror configuration options within the build documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/gitproxy-mirror

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@igorpecovnik igorpecovnik merged commit c2acbbd into main Jun 10, 2026
4 of 5 checks passed
@igorpecovnik igorpecovnik deleted the docs/gitproxy-mirror branch June 10, 2026 18:44
github-actions Bot pushed a commit that referenced this pull request Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs review Seeking for review size/small PR with less then 50 lines

Development

Successfully merging this pull request may close these issues.

1 participant