docs: clarify org profile scope and CI git transport#3
Open
QixinZhang26 wants to merge 1 commit into
Open
Conversation
- document the intended scope of the org profile repository\n- keep SSH URLs for local use while switching to HTTPS automatically in CI\n- preserve site_audit.html as-is because its generation path is not established here
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR tightens the
.githuborg-profile repo in two small ways:README.mdscripts/update_contributor_leaderboard.pyWhy
The contributor leaderboard script runs in GitHub Actions without an SSH key by default, so forcing SSH is brittle in CI. At the same time, local maintainers may still prefer SSH remotes. This keeps both paths working without changing the generated
site_audit.htmlartifact.Validation
python scripts/update_contributor_leaderboard.py --helpmaybe_use_https_git_url()behavior for local, CI, and explicit SSH modessite_audit.htmlwas restored and left unchanged