Skip to content

PREQ-7805 Fix config-pip README usage example order - #334

Merged
julien-carsique-sonarsource merged 1 commit into
masterfrom
fix/jcarsique/PREQ-7805-configPipReadmeOrder
Aug 6, 2026
Merged

PREQ-7805 Fix config-pip README usage example order#334
julien-carsique-sonarsource merged 1 commit into
masterfrom
fix/jcarsique/PREQ-7805-configPipReadmeOrder

Conversation

@julien-carsique-sonarsource

Copy link
Copy Markdown
Contributor

Summary

  • The config-pip ### Usage example in README.md showed actions/setup-python running before config-pip. That order defeats the fix's purpose: setup-python's own internal pip install --upgrade pip step still hits public pypi.org directly, before pip has been routed through Repox — which is exactly the SSL/PyPI-brownout failure reported in PREQ-7805.
  • Swapped the order so config-pip runs first, matching the pattern already fixed in SonarSource/sonardata-tools#59 and SonarSource/gh-action_releasability#150.
  • Confirmed via repo-wide search that this was the only setup-python reference in the repo (README, workflows, or other actions' docs) — no other examples needed the same fix. config-pip/action.yml and get-build-number/action.yml were also checked: neither invokes pip/python themselves, so reordering is safe.

Jira: PREQ-7805

Test plan

  • Doc-only change — verified rendered example order against the corrected pattern used in sonardata-tools#59 / gh-action_releasability#150

The example showed actions/setup-python running before config-pip,
which defeats the purpose: setup-python's internal pip upgrade would
still hit public pypi.org before pip is routed through Repox. Swap
the order so config-pip runs first, matching the fix already applied
in sonardata-tools#59 and gh-action_releasability#150.
Copilot AI review requested due to automatic review settings August 5, 2026 16:52
@julien-carsique-sonarsource
julien-carsique-sonarsource requested a review from a team as a code owner August 5, 2026 16:52
@hashicorp-vault-sonar-prod

hashicorp-vault-sonar-prod Bot commented Aug 5, 2026

Copy link
Copy Markdown

PREQ-7805

@gitar-bot

gitar-bot Bot commented Aug 5, 2026

Copy link
Copy Markdown
Code Review ✅ Approved

Reorders the config-pip usage example in the README so that setup-python runs after the configuration step, correctly routing pip through Repox. No issues found.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the config-pip documentation to ensure the usage example configures pip before actions/setup-python, so setup-python’s internal pip upgrade/install steps can use the configured repository routing (preventing direct access to public PyPI).

Changes:

  • Reordered the ### Usage YAML example steps so config-pip runs before actions/setup-python.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sonarqubecloud

sonarqubecloud Bot commented Aug 5, 2026

Copy link
Copy Markdown

@julien-carsique-sonarsource
julien-carsique-sonarsource merged commit f888541 into master Aug 6, 2026
22 checks passed
@julien-carsique-sonarsource
julien-carsique-sonarsource deleted the fix/jcarsique/PREQ-7805-configPipReadmeOrder branch August 6, 2026 07:57
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.

3 participants