docs: document backport workflow for generator fixes to stable branches#111
Open
jwulf wants to merge 1 commit into
Open
docs: document backport workflow for generator fixes to stable branches#111jwulf wants to merge 1 commit into
jwulf wants to merge 1 commit into
Conversation
Member
Author
|
@dependabot rebase |
Port the backport-workflow section into AGENTS.md (the consolidated agent guidelines file). The previous home, .github/copilot-instructions.md, was removed as part of #121's docs consolidation, so the original commit on this branch could not be cherry-picked verbatim. The content is unchanged from the original PR — definition of generator code (including runtime + partial-class infrastructure), why backporting is safe (release CI regenerates Generated/ on stable/*), the cherry-pick workflow, the local verification checklist, and the anti-patterns.
jwulf
force-pushed
the
docs/backport-generator-fixes
branch
from
0f0ff31 to
77f4940
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a "Backporting generator fixes to
stable/*branches" section to.github/copilot-instructions.md, mirroring the equivalent section recently added to the JS SDK (camunda/orchestration-cluster-api-js#161).What & why
Codifies the strategy we have been using on the JS SDK and now want to apply consistently across all three SDK repos: when a Dependabot bump of a generator dependency (e.g.
Microsoft.OpenApi,YamlDotNet) breaks generation onstable/N, we should land a generator-only fix onmainand cherry-pick it tostable/Nso the bump can succeed.Definition of "generator code" (for this repo)
src/Camunda.Orchestration.Sdk.Generator/(the generator project)src/Camunda.Orchestration.Sdk/Runtime/(hand-written runtime, ships unchanged)src/Camunda.Orchestration.Sdk/CamundaClient.cs(partial-class infrastructure)scripts/build*.sh,scripts/bundle-spec.shcamunda-schema-bundlerintegrationNOT generator code (no auto-backport):
src/Camunda.Orchestration.Sdk/Generated/(regenerated)Why it's safe here
.github/workflows/release.ymlalready regeneratesGenerated/on every release ofstable/*, auto-commits drift asfix(gen): regenerate artifacts, and publishes via semantic-release. A generator-only cherry-pick:Generated/under the currently pinned generator dependencies (verify locally).Notes