Skip to content

docs: Comprehensively update release branch creation guide#1082

Open
Steelskin wants to merge 2 commits intomainfrom
fabrice/update-docs-release-process
Open

docs: Comprehensively update release branch creation guide#1082
Steelskin wants to merge 2 commits intomainfrom
fabrice/update-docs-release-process

Conversation

@Steelskin
Copy link
Collaborator

Completely revise ReleaseProcess.md with detailed step-by-step instructions for creating new release branches:

  • Document all required updates to default.xml (default revision, LLVM project revision)
  • Detail build-toolchain.yml updates (swift_version, untagged repo revisions, snapshot job configuration)
  • Document dual-workflow structure: release branches use local references for direct testing, main uses @release/X.Y for scheduled builds
  • Add section on testing changes to release branches without requiring workflow modifications

Completely revise ReleaseProcess.md with detailed step-by-step
instructions for creating new release branches:

- Document all required updates to default.xml (default revision,
  LLVM project revision)
- Detail build-toolchain.yml updates (swift_version, untagged repo
  revisions, snapshot job configuration)
- Document dual-workflow structure: release branches use local
  references for direct testing, main uses @release/X.Y for scheduled
  builds
- Add section on testing changes to release branches without
  requiring workflow modifications
Copy link
Collaborator

@speednoisemovement speednoisemovement left a comment

Choose a reason for hiding this comment

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

LGTM % comment (but I've never done one of these e2e, so grain of salt)

create_release: ${{ github.event_name == 'schedule' }}
create_snapshot: ${{ github.event_name == 'schedule' }}
# Infrastructure/Runners
windows_x64_default_runner: <your-x64-runner-label>
Copy link
Collaborator

Choose a reason for hiding this comment

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

We also need to add "pinned" runner definitions (basically copy from main and rename). Example: thebrowsercompany/swift-build#324

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is public documentation and the pinned runners are an artifact of the downstream repository.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe just a note to make sure to capture runner state without specifics?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

How about adding docs in the downstream repository also explaining how it differs from compnerd/swift-build?

@Steelskin Steelskin requested a review from compnerd February 3, 2026 15:31
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.

4 participants