[docs]: prep for release#366
Conversation
- graph README: keep banner removed (matches GA branch intent) - devtools README: accept deletion from main Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
- version: 2.0.1-dev.{height} (dev builds on main)
- versionHeightOffset: 1
- remove alpha branch from publicReleaseRefSpec
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Prepares documentation and release configuration for a GA rollout by removing “public preview” messaging and deprecating the old microsoft/teams namespace shims.
Changes:
- Updates Nerdbank.GitVersioning configuration to a new dev version and adjusts release ref specs.
- Removes backward-compatibility shim
microsoft.teams.*__init__.pyfiles and associated backward-compat tests. - Updates READMEs to remove public preview cautions and adds a GA note to the root README; switches AzDO publish pipeline template to “Official”.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| version.json | Updates versioning string, height offset, and public release ref spec. |
| packages/graph/src/microsoft/teams/graph/init.py | Removes deprecated import-path shim for microsoft.teams.graph. |
| packages/common/tests/test_backward_compat.py | Removes tests that enforced old-namespace compatibility behavior. |
| packages/common/src/microsoft/teams/common/init.py | Removes deprecated import-path shim for microsoft.teams.common. |
| packages/common/README.md | Removes public preview caution banner. |
| packages/cards/src/microsoft/teams/cards/init.py | Removes deprecated import-path shim for microsoft.teams.cards. |
| packages/cards/README.md | Removes public preview caution banner. |
| packages/botbuilder/src/microsoft/teams/botbuilder/init.py | Removes deprecated import-path shim for microsoft.teams.botbuilder. |
| packages/apps/src/microsoft/teams/apps/init.py | Removes deprecated import-path shim for microsoft.teams.apps. |
| packages/apps/README.md | Removes public preview caution banner. |
| packages/api/src/microsoft/teams/api/init.py | Removes deprecated import-path shim for microsoft.teams.api. |
| packages/api/README.md | Removes public preview caution banner. |
| examples/graph/README.md | Removes public preview caution banner. |
| README.md | Replaces preview caution with GA announcement note. |
| .azdo/publish.yml | Switches pipeline template from Unofficial to Official. |
| "version": "2.0.1-dev.{height}", | ||
| "versionHeightOffset": 1, | ||
| "publicReleaseRefSpec": [ | ||
| "^refs/heads/alpha/v\\d+\\.\\d+\\.\\d+$", | ||
| "^refs/heads/release/v\\d+\\.\\d+\\.\\d+$" | ||
| ] |
There was a problem hiding this comment.
The PR description/root README indicates GA, but the GitVersioning config hard-codes a prerelease label (-dev.{height}), which will continue to produce prerelease versions even on “public release” refs. Consider using NerdBank.GitVersioning’s prerelease mechanisms (so prerelease can be omitted for public releases) or switching version to a stable SemVer on release refs. Also, reducing versionHeightOffset to 1 can change computed heights; ensure this won’t produce unexpected version sequences in your publishing pipeline.
| ref: refs/tags/release | ||
|
|
||
| extends: | ||
| template: v1/1ES.Unofficial.PipelineTemplate.yml@1esPipelines | ||
| template: v1/1ES.Official.PipelineTemplate.yml@1esPipelines |
There was a problem hiding this comment.
The pipeline pins resources to refs/tags/release, while version.json’s publicReleaseRefSpec matches refs/heads/release/vX.Y.Z. If the publish job runs from this tag ref, Nerdbank.GitVersioning may not treat it as a public release, potentially yielding prerelease-y version output (and mismatched artifact expectations). Align the tag/branch strategy (either adjust the pipeline ref to the branch pattern or update publicReleaseRefSpec to include the tag refs used for publishing).
Adds a scheduled ADO pipeline (`.azdo/sdl.yml`) using the `1ES.Official.PipelineTemplate` that runs weekly on `main`. **Why:** The publish pipeline is manually triggered and cannot guarantee CodeQL/CredScan run regularly on the default branch. This pipeline ensures continuous SDL compliance independent of release cadence. **How it works:** The 1ES Official template auto-injects CodeQL 3000 and CredScan in the SDL Sources stage. For interpreted languages, scanning is automatic based on file detection — no build step is needed. **Schedule:** Mondays at 08:00 UTC (`always: true` ensures it runs even without code changes). **Note:** After merging, a pipeline definition must be created in ADO (DomoreexpGithub/Github_Pipelines) pointing to this YAML file for the schedule to activate. **Related:** - #366 - microsoft/teams.ts#607 - microsoft/teams.ts#608 (TS counterpart) Co-authored-by: Copilot <[email protected]>
…#608) Adds a scheduled ADO pipeline (`.azdo/sdl.yml`) using the `1ES.Official.PipelineTemplate` that runs weekly on `main`. **Why:** The publish pipeline is manually triggered and cannot guarantee CodeQL/CredScan run regularly on the default branch. This pipeline ensures continuous SDL compliance independent of release cadence. **How it works:** The 1ES Official template auto-injects CodeQL 3000 and CredScan in the SDL Sources stage. For interpreted languages, scanning is automatic based on file detection — no build step is needed. **Schedule:** Mondays at 08:00 UTC (`always: true` ensures it runs even without code changes). **Note:** After merging, a pipeline definition must be created in ADO (DomoreexpGithub/Github_Pipelines) pointing to this YAML file for the schedule to activate. **Related:** - microsoft/teams.py#366 - microsoft#607 - microsoft/teams.py#449 (PY counterpart) Co-authored-by: Copilot <[email protected]>
…icrosoft#607) Switch the publish pipeline from `1ES.Unofficial.PipelineTemplate` to `1ES.Official.PipelineTemplate`. The Official template auto-injects CodeQL 3000 and CredScan on default-branch runs, which is required for SFI-PS2.1 (Continuous SDL) compliance. This is the same one-line change made to teams.py in microsoft/teams.py#366. Co-authored-by: Copilot <[email protected]>
microsoft/teams