Skip to content

docs: clarify org profile scope and CI git transport#3

Open
QixinZhang26 wants to merge 1 commit into
mainfrom
feature/org-profile-scope-ci-transport
Open

docs: clarify org profile scope and CI git transport#3
QixinZhang26 wants to merge 1 commit into
mainfrom
feature/org-profile-scope-ci-transport

Conversation

@QixinZhang26
Copy link
Copy Markdown

Summary

This PR tightens the .github org-profile repo in two small ways:

  • clarify the intended scope of the organization profile/community-health repository in README.md
  • keep SSH clone URLs for local workflows while automatically switching to HTTPS in CI inside scripts/update_contributor_leaderboard.py

Why

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.html artifact.

Validation

  • python scripts/update_contributor_leaderboard.py --help
  • verified maybe_use_https_git_url() behavior for local, CI, and explicit SSH modes
  • confirmed site_audit.html was restored and left unchanged

- 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant