Skip to content

Merge main into release/6.2 #1000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 7 additions & 43 deletions .github/workflows/automerge.yml
Original file line number Diff line number Diff line change
@@ -1,53 +1,17 @@
name: Create PR to merge main into release branch

# In the first period after branching the release branch, we typically want to include all changes from `main` also in the release branch. This workflow automatically creates a PR every Monday to merge main into the release branch.
# Later in the release cycle we should stop this practice to avoid landing risky changes by disabling this workflow. To do so, disable the workflow as described in https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow

on:
schedule:
- cron: '0 0 * * MON'
- cron: '0 9 * * MON'
workflow_dispatch:

jobs:
create_merge_pr:
name: Create PR to merge main into release branch
runs-on: ubuntu-latest
uses: swiftlang/github-workflows/.github/workflows/create_automerge_pr.yml@main
with:
base_branch: release/6.2
permissions:
contents: write
pull-requests: write
if: (github.event_name == 'schedule' && github.repository == 'swiftlang/swift-format') || (github.event_name != 'schedule') # Ensure that we don't run this on a schedule in a fork
steps:
- name: Set up variables
id: variables
run: |
echo "release_branch=release/6.2" >> "$GITHUB_OUTPUT"
echo "pr_branch=automerge/merge-main-$(date +%Y-%m-%d)" >> "$GITHUB_OUTPUT"
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Create merge commit
id: create_merge_commit
run: |
# Without this, we can't perform git operations in GitHub actions.
git config --global --add safe.directory "$(realpath .)"
git config --local user.name 'swift-ci'
git config --local user.email '[email protected]'

git checkout ${{ steps.variables.outputs.release_branch }}
git merge main

if [[ "$(git rev-parse HEAD)" = "$(git rev-parse main)" ]]; then
echo "has_merged_commits=true" >> "$GITHUB_OUTPUT"
else
echo "has_merged_commits=false" >> "$GITHUB_OUTPUT"
fi
- name: Push branch and create PR
id: push_branch
if: ${{ steps.create_merge_commit.outputs.has_merged_commits }}
env:
GH_TOKEN: ${{ github.token }}
run: |
git checkout -b "${{ steps.variables.outputs.pr_branch }}"
git push --set-upstream origin "${{ steps.variables.outputs.pr_branch }}"

gh pr create -B "${{ steps.variables.outputs.release_branch }}" -H "${{ steps.variables.outputs.pr_branch }}" \
--title 'Merge `main` into `${{ steps.variables.outputs.release_branch }}`' \
--body 'This PR was automatically opened by a GitHub action. Review the changes included in this PR and determine if they should be included in the release branch. If yes, merge the PR. Otherwise revert changes that should not be included on this branch.'
11 changes: 9 additions & 2 deletions Sources/swift-format/Frontend/Frontend.swift
Original file line number Diff line number Diff line change
Expand Up @@ -200,14 +200,21 @@ class Frontend {
/// Creates a new frontend with the given options.
///
/// - Parameter lintFormatOptions: Options that apply during formatting or linting.
init(configurationOptions: ConfigurationOptions, lintFormatOptions: LintFormatOptions) {
init(
configurationOptions: ConfigurationOptions,
lintFormatOptions: LintFormatOptions,
treatWarningsAsErrors: Bool = false
) {
self.configurationOptions = configurationOptions
self.lintFormatOptions = lintFormatOptions

self.diagnosticPrinter = StderrDiagnosticPrinter(
colorMode: lintFormatOptions.colorDiagnostics.map { $0 ? .on : .off } ?? .auto
)
self.diagnosticsEngine = DiagnosticsEngine(diagnosticsHandlers: [diagnosticPrinter.printDiagnostic])
self.diagnosticsEngine = DiagnosticsEngine(
diagnosticsHandlers: [diagnosticPrinter.printDiagnostic],
treatWarningsAsErrors: treatWarningsAsErrors
)
self.configurationProvider = ConfigurationProvider(diagnosticsEngine: self.diagnosticsEngine)
}

Expand Down
16 changes: 6 additions & 10 deletions Sources/swift-format/Subcommands/Lint.swift
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ extension SwiftFormatCommand {

@Flag(
name: .shortAndLong,
help: "Fail on warnings. Deprecated: All findings are treated as errors now."
help: "Treat all findings as errors instead of warnings."
)
var strict: Bool = false

Expand All @@ -37,15 +37,11 @@ extension SwiftFormatCommand {

func run() throws {
try performanceMeasurementOptions.printingInstructionCountIfRequested {
let frontend = LintFrontend(configurationOptions: configurationOptions, lintFormatOptions: lintOptions)

if strict {
frontend.diagnosticsEngine.emitWarning(
"""
Running swift-format with --strict is deprecated and will be removed in the future.
"""
)
}
let frontend = LintFrontend(
configurationOptions: configurationOptions,
lintFormatOptions: lintOptions,
treatWarningsAsErrors: strict
)
frontend.run()

if frontend.diagnosticsEngine.hasErrors {
Expand Down
12 changes: 10 additions & 2 deletions Sources/swift-format/Utilities/DiagnosticsEngine.swift
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,28 @@ final class DiagnosticsEngine {
/// A Boolean value indicating whether any warnings were emitted by the diagnostics engine.
private(set) var hasWarnings: Bool

/// Whether to upgrade all warnings to errors.
private let treatWarningsAsErrors: Bool

/// Creates a new diagnostics engine with the given diagnostic handlers.
///
/// - Parameter diagnosticsHandlers: An array of functions, each of which takes a `Diagnostic` as
/// its sole argument and returns `Void`. The functions are called whenever a diagnostic is
/// received by the engine.
init(diagnosticsHandlers: [(Diagnostic) -> Void]) {
init(diagnosticsHandlers: [(Diagnostic) -> Void], treatWarningsAsErrors: Bool = false) {
self.handlers = diagnosticsHandlers
self.hasErrors = false
self.hasWarnings = false
self.treatWarningsAsErrors = treatWarningsAsErrors
}

/// Emits the diagnostic by passing it to the registered handlers, and tracks whether it was an
/// error or warning diagnostic.
private func emit(_ diagnostic: Diagnostic) {
var diagnostic = diagnostic
if treatWarningsAsErrors, diagnostic.severity == .warning {
diagnostic.severity = .error
}
switch diagnostic.severity {
case .error: self.hasErrors = true
case .warning: self.hasWarnings = true
Expand Down Expand Up @@ -135,7 +143,7 @@ final class DiagnosticsEngine {
/// diagnostics engine and returns it.
private func diagnosticMessage(for finding: Finding) -> Diagnostic {
return Diagnostic(
severity: .error,
severity: .warning,
location: finding.location.map(Diagnostic.Location.init),
category: "\(finding.category)",
message: "\(finding.message.text)"
Expand Down
Loading