Skip to content

Commit 9dd3283

Browse files
bmehta001Copilot
andauthored
Add maintainer onboarding and release guidance (microsoft#1529)
* Add maintainer onboarding and release guidance Centralize build, validation, PR, and release practices so maintainers can follow one current operational guide. Files changed: - README.md - docs/maintainer-onboarding.md - docs/versioning.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a7d76f00-9675-4f19-9639-118e0d3dab4e * Clarify preliminary Apple platform packaging Avoid overstating Mac Catalyst and visionOS support while documenting the SPM xcframework slices available for evaluation. Files changed: - README.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a7d76f00-9675-4f19-9639-118e0d3dab4e * Document Windows support floor and leak-review expectations docs/maintainer-onboarding.md: guide maintainers to review non-gating leak warnings and avoid unsupported Windows compatibility work. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix release generator path and prevent missed SPM hotfixes Make tools/gen-version.sh run relative to its script directory so documented root invocations work. Clarify the SPM X.Y.Z collision for fourth-component-only corrections in docs/maintainer-onboarding.md and docs/versioning.md; verified against .github/workflows/spm-release.yml. The leak-workflow link already resolves in the merged main at a387a25; no separate fix is needed. Files changed: tools/gen-version.sh, docs/maintainer-onboarding.md, docs/versioning.md. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a7d76f00-9675-4f19-9639-118e0d3dab4e
1 parent 6416f1f commit 9dd3283

7 files changed

Lines changed: 493 additions & 114 deletions

File tree

‎README.md‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,20 @@ as the communication channel for both feature requests and issues.
3838
contributors](https://github.com/orgs/microsoft/teams/everyone) - please refer
3939
to contributing instructions
4040
[here](https://github.com/microsoft/cpp_client_telemetry_modules/blob/master/CONTRIBUTING.md).**
41+
42+
- Repository maintainers and engineers making substantial changes should start
43+
with the [maintainer onboarding guide](docs/maintainer-onboarding.md) for the
44+
documentation reading order, local build and validation matrix, PR checklist,
45+
and release process.
4146

4247
## Release policy:
4348

44-
The SDK is released as a [source package](https://github.com/microsoft/cpp_client_telemetry/releases)
45-
on need basis.
46-
There is no plan to release prebuilt binaries.
49+
The SDK's primary release artifact is a
50+
[source package](https://github.com/microsoft/cpp_client_telemetry/releases),
51+
published on an as-needed basis. A preliminary Swift Package Manager packaging
52+
flow is designed to distribute a prebuilt Apple xcframework; see the
53+
[Apple packaging guide](tools/apple/README.md) for its current status and
54+
available slices.
4755

4856
## Build
4957

@@ -56,6 +64,7 @@ Platform specific build instructions:
5664
* [iOS/iPadOS](docs/cpp-start-ios.md)
5765
* [Android](docs/cpp-start-android.md)
5866
* [CMake source embedding / FetchContent](docs/embedding-with-cmake.md)
67+
* [Swift Package Manager xcframework](tools/apple/README.md)
5968

6069
Standard configure/build presets are listed with `cmake --list-presets`.
6170
`build.sh`, `build-ios.sh`, and `build-cmake.ps1` are thin compatibility
@@ -105,6 +114,10 @@ Other resources to learn how to setup the build system:
105114
* For iOS simulator, CI covers representative supported simulator
106115
configurations on the current macOS runner images rather than every
107116
supported iOS 12+ runtime.
117+
* The Swift Package Manager xcframework includes preliminary Mac Catalyst 14+
118+
and visionOS 1+ device and simulator slices. These targets have received
119+
limited validation and are not currently covered by regular CI. Evaluate
120+
them for your scenario before production use.
108121

109122
## Test
110123

@@ -131,7 +144,8 @@ the test results.
131144

132145
## Versioning
133146

134-
This library follows [Semantic Versioning](http://semver.org/).
147+
See the [release and version strategy](docs/versioning.md) and the
148+
[maintainer release checklist](docs/maintainer-onboarding.md#cutting-a-release).
135149

136150
## License
137151

0 commit comments

Comments
 (0)