Skip to content

Update Swift Package Manager pubspec.yaml syntax to use config section #12925

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.

Sign up for GitHub

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

Jump to bottom
Merged
sfshaza2 merged 1 commit into from
Jan 13, 2026
Merged

Update Swift Package Manager pubspec.yaml syntax to use config section #12925

sfshaza2 merged 1 commit into from
Jan 13, 2026
+9 −2

Conversation

@dbebawy
Copy link
Contributor

@dbebawy dbebawy commented Jan 13, 2026

Description

Updates the Swift Package Manager documentation to use the new flutter: config: section format for pubspec.yaml configuration, replacing the deprecated disable-swift-package-manager field.

Changes

File: src/_includes/docs/swift-package-manager/how-to-enable-disable.md

Before (deprecated)

flutter:
  disable-swift-package-manager: true

After (current)

flutter:
  config:
    enable-swift-package-manager: false

Additional Changes

  • Added a migration note to help users who were using the deprecated syntax
  • The note explains that the old syntax produces an error in Flutter 3.38 and later

Context

This change aligns the Swift Package Manager documentation with:

Testing

  • Verified the new syntax matches what's documented in src/content/tools/pubspec.md
  • Confirmed the markdown formatting follows existing patterns in the file

Related Issues

Fixes #12924

Pre-launch Checklist

  • I read the Contributor Guide
  • I signed the CLA
  • I listed at least one issue that this PR fixes in the description above

@dbebawy
docs: update Swift Package Manager pubspec.yaml syntax to use config …
f8193a4 
…section

The `disable-swift-package-manager` field is deprecated. Update the
documentation to use the new `flutter: config: enable-swift-package-manager`
syntax introduced in flutter/flutter#168433.

Also added a migration note to help users who were using the old syntax.

Fixes flutter#12924
@dbebawy dbebawy requested review from a team and sfshaza2 as code owners January 13, 2026 19:06
@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Jan 13, 2026

Summary of Changes

Hello @dbebawy, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the Swift Package Manager documentation to align with the latest pubspec.yaml configuration structure in Flutter. It replaces an outdated configuration field with the current flutter: config: syntax and provides clear guidance for users migrating from the deprecated format, ensuring the documentation remains accurate and prevents potential build errors for users on newer Flutter versions.

Highlights

  • Documentation Update: The Swift Package Manager documentation has been updated to reflect the current flutter: config: section format for pubspec.yaml configuration.
  • Deprecated Syntax Removal: The deprecated disable-swift-package-manager field has been replaced with enable-swift-package-manager: false within the new config section.
  • Migration Guidance: A new migration note has been added to guide users who were previously using the deprecated syntax, clarifying that the old format will cause errors in Flutter 3.38 and later.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist bot reviewed Jan 13, 2026
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request correctly updates the Swift Package Manager documentation to reflect the new pubspec.yaml configuration syntax. The change from the deprecated disable-swift-package-manager field to the config section is well-documented, and the addition of a migration note is a great improvement for user experience. I have one suggestion to align the formatting of the new note with the existing documentation style.

@sfshaza2
Copy link
Contributor

sfshaza2 commented Jan 13, 2026

/gbcrun

@sfshaza2
Copy link
Contributor

sfshaza2 commented Jan 13, 2026

This looks good to me, but can you review, @vashworth?

@sfshaza2 sfshaza2 requested a review from vashworth January 13, 2026 19:17
@sfshaza2
Copy link
Contributor

sfshaza2 commented Jan 13, 2026

/gcbrun

@flutter-website-bot
Copy link
Collaborator

flutter-website-bot commented Jan 13, 2026

Visit the preview URL for this PR (updated for commit f8193a4):

https://flutter-docs-prod--pr12925-fix-spm-pubspec-config-synt-pmakbupc.web.app

@sfshaza2 sfshaza2 changed the title docs: update Swift Package Manager pubspec.yaml syntax to use config section Update Swift Package Manager pubspec.yaml syntax to use config section Jan 13, 2026
@sfshaza2
Copy link
Contributor

sfshaza2 commented Jan 13, 2026

Thanks, @dbebawy!

sfshaza2
sfshaza2 approved these changes Jan 13, 2026
View reviewed changes
Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

lgtm

@sfshaza2 sfshaza2 merged commit 5cb1a3c into flutter:main Jan 13, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vashworth vashworth vashworth approved these changes

@sfshaza2 sfshaza2 sfshaza2 approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Swift Package Manager docs use deprecated pubspec.yaml syntax

4 participants

@dbebawy @sfshaza2 @flutter-website-bot @vashworth