Skip to content

docs: clarify release process followups - #5232

Open
iscai-msft wants to merge 5 commits into
Azure:mainfrom
iscai-msft:iscai-msft-release-process-docs
Open

docs: clarify release process followups#5232
iscai-msft wants to merge 5 commits into
Azure:mainfrom
iscai-msft:iscai-msft-release-process-docs

Conversation

@iscai-msft

Copy link
Copy Markdown
Member

Summary

  • clarify release-note publishing, specs branch handling, and cleanup steps
  • link partner emails to release notes instead of duplicating their contents
  • document unresolved cross-repository release TODOs

TODO

  • Investigate an automation workflow for bidirectional synchronization between typespec-next and main in azure-rest-api-specs.

Testing

  • Not run (documentation-only change).

iscai-msft and others added 3 commits April 30, 2025 16:17
@github-actions

Copy link
Copy Markdown
Contributor

No changes needing a change description found.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: a9c5f8c1-6e8f-44a4-887f-ce06c121eacc
@azure-sdk-automation

Copy link
Copy Markdown
Contributor

You can try these changes here

🛝 Playground 🌐 Website

Comment thread CONTRIBUTING.md Outdated
5. After update PRs have been merged, review any remaining reported vulnerabilities in both the Repos' `Security` tabs and initiate a discussion on the `Engineering` channel regarding potential mitigations. `Security` tab links: [typespec](https://github.com/microsoft/typespec/security) and [typespec-azure](https://github.com/Azure/typespec-azure/security).
2. Merge the `typespec-next` changes into the `RPSaasMaster` branch for the `-pr` repository.
3. Reset `typespec-next` to `main` after completing the upgrades.
4. Send an email to the `TypeSpec Partners` group announcing the release and link to the TypeSpec and TypeSpec Azure release notes. Include highlights when appropriate rather than duplicating the complete release notes.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd like to receive these emails when it's not my turn to release, how about we also mention adding the TypeSpec Team in cc?

Comment thread CONTRIBUTING.md Outdated

### Open questions and TODOs

1. Determine whether the [data-plane linter-rule coverage guidance](https://github.com/Azure/azure-rest-api-specs/blob/main/.github/skills/azure-api-review/references/data-plane-linter-rule-coverage.md#-landing----merged-upstream-not-yet-running-here) must be updated after a newly added rule causes CI failures while upgrading package versions.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would like to find a solution where folks can add skills that rely on TypeSpec but which does not require us to include all their skills in our updates. In this particular case, the specs repo had some testing that failed on the update, so I think we need to investigate how to make the skills robust to typespec changes so that their owners have a couple of days to update after a tsp library version update

Comment thread CONTRIBUTING.md Outdated
1. Determine whether the [data-plane linter-rule coverage guidance](https://github.com/Azure/azure-rest-api-specs/blob/main/.github/skills/azure-api-review/references/data-plane-linter-rule-coverage.md#-landing----merged-upstream-not-yet-running-here) must be updated after a newly added rule causes CI failures while upgrading package versions.
2. Define a safe process for updating specification files in the specification repositories without overwriting changes merged to `main` while the update PR is being prepared.
3. Confirm with Mark and Timothee which files should be updated after running `pnpm upgrade --latest -r -i`, including whether to prefer broader or narrower dependency updates.
4. Automate bidirectional synchronization between `typespec-next` and `main` in `azure-rest-api-specs`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1 to this, seems like something we should be able to automate

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: a9c5f8c1-6e8f-44a4-887f-ce06c121eacc
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.

2 participants