Skip to content

Commit af6ec92

Browse files
committed
Fix docs and comments: align parameter values, Python version range, and pipeline diagram
1 parent a55942d commit af6ec92

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

.Pipelines/ADO-PUBLISH-SETUP.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Every publish requires explicitly entering a version and selecting a destination
2323
| Stage | Trigger | Target |
2424
|-------|---------|--------|
2525
| **Validate** | always | asserts `packageVersion` matches `msal/sku.py` |
26-
| **CI** (tests on Py 3.9–3.13) | after Validate ||
26+
| **CI** (tests on Py 3.9–3.14) | after Validate ||
2727
| **Build** (sdist + wheel) | after CI | dist artifact |
2828
| **PublishMSALPython** | `publishTarget = test.pypi.org (Preview / RC)` | test.pypi.org |
2929
| **PublishPyPI** | `publishTarget = pypi.org (Production)` | PyPI (production) |
@@ -190,13 +190,13 @@ This pipeline is **always manually queued**. Both fields are required — the Va
190190
## Pipeline Trigger Reference
191191

192192
```
193-
Manual queue (publishTarget = MSAL-Python)
193+
Manual queue (publishTarget = test.pypi.org (Preview / RC))
194194
└─► Validate ─► CI ─► Build ─► PublishMSALPython
195-
(test.pypi.org, auto)
195+
(test.pypi.org (Preview / RC), auto)
196196
197-
Manual queue (publishTarget = pypi)
197+
Manual queue (publishTarget = pypi.org (Production))
198198
└─► Validate ─► CI ─► Build ─► PublishPyPI
199-
(PyPI, requires approval)
199+
(pypi.org (Production), requires approval)
200200
```
201201

202202
---
@@ -208,7 +208,7 @@ The following requirements were identified during initial setup and testing:
208208
- The GitHub service connection **must** be created via OAuth (Grant authorization) in the ADO UI, not via CLI or PAT. The CLI `az pipelines create` command requires webhook installation on the GitHub repo, which requires org admin rights not available to service accounts.
209209
- The pipeline **must** be created via the ADO REST API (`/_apis/build/definitions`) or UI — not via `az pipelines create` — when using an OAuth GitHub service connection without org-level admin rights.
210210
- The `msal/sku.py __version__` must be updated and pushed to the source branch **before** the pipeline run is queued. The Validate stage reads the file from the checked-out branch at runtime.
211-
- The `requirements.txt` file includes `-e .` which causes pip to install `msal` from PyPI as a transitive dependency of `azure-identity`, overwriting the local editable install. The template handles this by removing the `-e .` line and reinstalling the local package last with `--no-deps`.
211+
- The `requirements.txt` file includes `-e .` (editable local install of `msal`). `azure-identity` does not depend on `msal`, so no PyPI version is pulled in as a transitive dependency and the local package is not overwritten. The template installs dependencies with `pip install -r requirements.txt`, which installs the editable local copy directly.
212212
- The `1.35.1` version bump (hotfix) was released from `origin/release-1.35.0` and was never merged back into `dev`. Before the next release from `dev`, this should be backfilled via PR: `https://github.com/AzureAD/microsoft-authentication-library-for-python/compare/dev...release-1.35.0`
213213

214214
---
@@ -221,7 +221,7 @@ The following requirements were identified during initial setup and testing:
221221
| `File already exists` error | Version already published; PyPI does not allow overwriting | Bump version in `msal/sku.py` |
222222
| Validate stage: `msal/sku.py ''` (empty version) | Python import silently failed | The template uses `grep`/`sed` to read the version — verify `msal/sku.py` contains a `__version__ = "..."` line |
223223
| Validate stage: version mismatch | `sku.py` on the source branch doesn't match the parameter entered | Update `msal/sku.py` on the branch the run is sourced from, not just the pipeline default branch |
224-
| Tests: collection failure across all modules | PyPI `msal` installed over the local editable install | Ensure the template installs local package last with `--no-deps` |
224+
| Tests: collection failure across all modules | Missing or broken dependency | Run `pip install -r requirements.txt` locally and confirm `msal` resolves to the local editable install (check `pip show msal`) |
225225
| `az pipelines create` fails with webhook error | GitHub service connection PAT/account lacks org admin rights | Create the pipeline via the ADO UI using a browser session with org admin GitHub access |
226226
| Pipeline creation fails: `Value cannot be null. Parameter name: Connection` | GitHub SC ID is wrong or SC was recreated | Re-query the SC ID with `az devops service-endpoint list` and use the current ID |
227227
| Service connection shows `Authentication: PersonalAccessToken` | SC was created via CLI with a PAT | Delete and recreate via UI using OAuth (Grant authorization) so repos are enumerable |

.Pipelines/pipeline-publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ stages:
118118
artifactName: python-dist
119119

120120
# ══════════════════════════════════════════════════════════════════════════════
121-
# Stage 4a · Publish to test.pypi.org (Preview / RC) for MSAL-Python
121+
# Stage 4a · Publish to MSAL-Python (test.pypi.org)
122122
# Runs when: publishTarget == 'test.pypi.org (Preview / RC)'
123123
# ══════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════
124124
- stage: PublishMSALPython
@@ -150,7 +150,7 @@ stages:
150150

151151
# ══════════════════════════════════════════════════════════════════════════════
152152
# Stage 4b · Publish to PyPI
153-
# Runs when: publishTarget == 'pypi'
153+
# Runs when: publishTarget == 'pypi.org (Production)'
154154
# ══════════════════════════════════════════════════════════════════════════════
155155
- stage: PublishPyPI
156156
displayName: 'Publish to PyPI (Production)'

0 commit comments

Comments
 (0)