Eng Hub docs missing info on prepare release script
- Dominant language
- C#
- Stars
- 135
- Forks
- 260
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 115
Description
The [Azure SDK Eng Hub docs on releasing SDKs](https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release?tabs=dataplane) is missing a step on running the `Prepare-Release.ps1`.
The prepare release script is needed to properly set the Package Display Name and Service Name metadata in the release csv files. This data is used for the Releases Site and Ref Docs TOCs.
[Old Doc from Azure SDK ADO Wiki](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/444/Marking-a-Package-as-In-Release)
Contributor guide
Research direction
Start with the linked Azure SDK Eng Hub release documentation and compare it with the old ADO Wiki page, focusing on where release preparation steps are described. Document when to run Prepare-Release.ps1 and why it is needed; the release guide should clearly include the step and its metadata purpose.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100